{"info":{"title":"Health Data Service Interface (HDSI)","description":"Represents generic implementation of the the Health Data Service Interface (HDSI) contract","version":"3.0.2098.0 (3.0.2098-alpha+b3f0c55c32c8da39347dbf4fbf083e9b6131f3d5)"},"basePath":"/hdsi","host":"ims-ncc1701.santesuite.net:8443","schemes":["https"],"swagger":"2.0","paths":{"/time":{"get":{"tags":[],"summary":"Time","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":true}},"/CodeSystem/_export":{"get":{"tags":["CodeSystem"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the code system","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the Oid of the code system","type":"string"},{"name":"authority","in":"query","description":"Gets or sets the authority of the code system","type":"string"},{"name":"url","in":"query","description":"Gets or sets the URL of the code system","type":"string"},{"name":"version","in":"query","description":"Gets or sets the version text of the code system","type":"string"},{"name":"description","in":"query","description":"Gets or sets the human description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodeSystem"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/QuantityObservation/_export":{"get":{"tags":["QuantityObservation"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"value","in":"query","description":"Gets or sets the observed quantity","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"unitOfMeasure","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ActRelationship/_export":{"get":{"tags":["ActRelationship"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"sequence","in":"query","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ActRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Observation/_export":{"get":{"tags":["Observation"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/_export":{"get":{"tags":["PatientEncounter"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"dischargeDisposition","in":"query","description":"Gets or sets the key of discharge disposition","type":"string"},{"name":"admissionSource","in":"query","description":"Gets or sets the admission source type","type":"string"},{"name":"specialArrangement","in":"query","description":"A list of special arrangements which are to be made to the patient during the encounter","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/_export":{"get":{"tags":["Patient"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ReferenceTerm/_export":{"get":{"tags":["ReferenceTerm"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the reference term","type":"string"},{"name":"codeSystem","in":"query","description":"Gets or sets the code system identifier","type":"string"},{"name":"name","in":"query","description":"Gets display names associated with the reference term","type":"string"},{"name":"concept","in":"query","description":"Gets or sets the concepts related to this data","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/_export":{"get":{"tags":["ExtensionType"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"handlerClass","in":"query","description":"Gets or sets the description","type":"string"},{"name":"uri","in":"query","description":"Gets or sets the uri of the extension","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the extension","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ExtensionType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/_export":{"get":{"tags":["Container"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"capacityQuantity","in":"query","description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"string"},{"name":"diameterQuantity","in":"query","description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"string"},{"name":"heightQuantity","in":"query","description":"Gets or sets the height quantity. The height of the container.","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/_export":{"get":{"tags":["DeviceEntity"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"manufacturerModelName","in":"query","description":"Gets or sets the manufacturer model name","type":"string"},{"name":"operatingSystemName","in":"query","description":"Gets or sets the operating system name","type":"string"},{"name":"securityDevice","in":"query","description":"Gets or sets the security device key","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/_export":{"get":{"tags":["UserEntity"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"securityUser","in":"query","description":"Gets or sets the security user key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TextObservation/_export":{"get":{"tags":["TextObservation"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the textual value","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Place/_export":{"get":{"tags":["Place"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"isMobile","in":"query","description":"True if location is mobile","type":"boolean"},{"name":"service","in":"query","description":"Gets the services","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailMessage/_export":{"get":{"tags":["MailMessage"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"body","in":"query","description":"Gets or sets the alert body of the alert.","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the status of the alert.","type":"string","enum":[]},{"name":"from","in":"query","description":"Gets or sets the \"from\" subject if it is a human based message of the alert.","type":"string"},{"name":"fromInfo","in":"query","description":"From Information (string representation)","type":"string"},{"name":"toInfo","in":"query","description":"To information","type":"string"},{"name":"to","in":"query","description":"Legacy property for the \"to\" field (so sync can occur on older tablets)","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets or sets the time this was modified on","type":"string"},{"name":"rcpt","in":"query","description":"The recipient users used for query","type":"string"},{"name":"subject","in":"query","description":"Gets or sets the subject of the alert.","type":"string"},{"name":"mailbox","in":"query","description":"Gets the messages for this mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TemplateDefinition/_export":{"get":{"tags":["TemplateDefinition"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"name","in":"query","description":"Gets or set the name","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TemplateDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/_export":{"get":{"tags":["ManufacturedMaterial"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Narrative/_export":{"get":{"tags":["Narrative"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"versionCode","in":"query","description":"The external version number of the structured document","type":"string"},{"name":"language","in":"query","description":"The language in which the document content is written","type":"string"},{"name":"mime","in":"query","description":"Gets or sets the mime type of the narrative content","type":"string"},{"name":"title","in":"query","description":"The title of the clinical document","type":"string"},{"name":"text","in":"query","description":"Gets or sets the text of the document","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DeviceMailbox/_export":{"get":{"tags":["DeviceMailbox"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1"]}],"deprecated":false}},"/SubstanceAdministration/_export":{"get":{"tags":["SubstanceAdministration"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"route","in":"query","description":"Gets or sets the key for route","type":"string"},{"name":"doseUnit","in":"query","description":"Gets or sets the key for dosing unit","type":"string"},{"name":"doseQuantity","in":"query","description":"Gets or sets the amount of substance administered","type":"number"},{"name":"doseSequence","in":"query","description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"string"},{"name":"site","in":"query","description":"Gets or sets the site","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePlan/_export":{"get":{"tags":["CarePlan"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"title","in":"query","description":"Gets or sets a human title for the care plan","type":"string"},{"name":"pathway","in":"query","description":"Identifies the care pathway identifier which this care plan is generated for","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/_export":{"get":{"tags":["Mailbox"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Mailbox"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/_export":{"get":{"tags":["ConceptExtension"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Person/_export":{"get":{"tags":["Person"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Organization/_export":{"get":{"tags":["Organization"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"industryConcept","in":"query","description":"Gets or sets the concept key which classifies the industry in which the organization operates","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/_export":{},"/ConceptRelationship/_export":{"get":{"tags":["ConceptRelationship"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"targetConcept","in":"query","description":"Gets or sets the target concept identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Relationship type","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Procedure/_export":{"get":{"tags":["Procedure"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"method","in":"query","description":"Gets or sets te method/technique used to perform the procedure","type":"string"},{"name":"approachSite","in":"query","description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string"},{"name":"targetSite","in":"query","description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ApplicationEntity/_export":{"get":{"tags":["ApplicationEntity"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"securityApplication","in":"query","description":"Gets or sets the security application","type":"string"},{"name":"softwareName","in":"query","description":"Gets or sets the name of the software","type":"string"},{"name":"vendorName","in":"query","description":"Gets or sets the vendoer name of the software","type":"string"},{"name":"versionName","in":"query","description":"Gets or sets the version of the software","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/_export":{"get":{"tags":["Concept"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},{"name":"statusConcept","in":"query","description":"Gets or sets the status concept key","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of concept relationships","type":"string"},{"name":"conceptClass","in":"query","description":"Gets or sets the class identifier","type":"string"},{"name":"referenceTerm","in":"query","description":"Gets a list of concept reference terms","type":"string"},{"name":"name","in":"query","description":"Gets the concept names","type":"string"},{"name":"conceptSet","in":"query","description":"Concept sets as identifiers for XML purposes only","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the concept","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/StockLedgerEntry/_export":{"get":{"tags":["StockLedgerEntry"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"sequence","in":"query","description":"Gets or sets the sequence of this entry in the ledger","type":"string"},{"name":"act","in":"query","description":"Gets or sets the act which caused this ledger entry to be created","type":"string"},{"name":"container","in":"query","description":"Gets or sets the container to which this ledger entry applies","type":"string"},{"name":"material","in":"query","description":"Gets or sets the material to which the ledger entry applies","type":"string"},{"name":"reason","in":"query","description":"Gets or sets the reason for the ledger entry","type":"string"},{"name":"startOfLine","in":"query","description":"Gets or sets the start of line balance (the known balance before the entry was created)","type":"number"},{"name":"quantity","in":"query","description":"Gets or sets the quantity of the current ledger entry","type":"number"},{"name":"createdBy","in":"query","description":"Gets or sets the security principal that was responsible for the cretion of this ledger entry","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the time that this ledger entry was created","type":"string"},{"name":"timestamp","in":"query","description":"Gets or sets the timestamp when the ledger entry applies to","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the modification date of this object entry","type":"string"},{"name":"type","in":"query","description":"Gets or sets the stock ledger entry type","type":"string","enum":["ledger","rollback","purged"]},{"name":"ref","in":"query","description":"If this entry points to another entry, then the pointer to the entry being referenced","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/StockLedgerEntry"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/IdentityDomain/_export":{"get":{"tags":["IdentityDomain"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the assigning authority","type":"string"},{"name":"domainName","in":"query","description":"Gets or sets the domain name of the assigning authority","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the assigning authority","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the assigning authority","type":"string"},{"name":"url","in":"query","description":"The URL of the assigning authority","type":"string"},{"name":"assigningAuthority","in":"query","description":"Assigning device identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string"},{"name":"identifierClass","in":"query","description":"Gets or sets the identifier classification key","type":"string"},{"name":"validation","in":"query","description":"Gets or sets the validation regex","type":"string"},{"name":"isUnique","in":"query","description":"True if the assigning authority values should be unique","type":"boolean"},{"name":"customValidator","in":"query","description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},{"name":"checkDigitAlgorithm","in":"query","description":"Gets or sets the check digit algorithm","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/IdentityDomain"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/_export":{"get":{"tags":["Act"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/_export":{"get":{"tags":["PlaceService"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"serviceConcept","in":"query","description":"Gets or sets the service concept key","type":"string"},{"name":"serviceSchedule","in":"query","description":"The schedule that the service is offered","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PlaceService"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/_export":{"get":{"tags":["Entity"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DateObservation/_export":{"get":{"tags":["DateObservation"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"valuePrecision","in":"query","description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePathwayDefinition/_export":{"get":{"tags":["CarePathwayDefinition"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the care pathway","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the care pathway","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the care pathway","type":"string"},{"name":"eligibility","in":"query","description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},{"name":"enrollment","in":"query","description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},{"name":"encounterTemplate","in":"query","description":"Gets or sets the type of encounter","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptClass/_export":{"get":{"tags":["ConceptClass"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the concept class","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptClass"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityExtension/_export":{"get":{"tags":["EntityExtension"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/_export":{"get":{"tags":["EntityRelationship"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"holder","in":"query","description":"The entity that this relationship targets","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"strength","in":"query","description":"The strength (confidence) of the relationship between source and target","type":"string"},{"name":"quantity","in":"query","description":"Represents the quantity of target in source","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"relationshipRole","in":"query","description":"Association type key","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Protocol/_export":{"get":{"tags":["Protocol"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the protocol","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the OID","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Protocol"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptReferenceTerm/_export":{"get":{"tags":["ConceptReferenceTerm"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"term","in":"query","description":"Gets or sets the reference term identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Gets or sets the relationship type identifier","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationshipType/_export":{"get":{"tags":["ConceptRelationshipType"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the relationship","type":"string"},{"name":"mnemonic","in":"query","description":"The invariant of the relationship type","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationshipType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodedObservation/_export":{"get":{"tags":["CodedObservation"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptSet/_export":{"get":{"tags":["ConceptSet"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptSet"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/_export":{"get":{"tags":["Material"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailboxMailMessage/_export":{"get":{"tags":["MailboxMailMessage"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/_export":{"get":{"tags":["Provider"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"body","type":"string"},{"name":"providerSpecialty","in":"query","description":"Gets or sets the provider specialty key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/{id}/_export":{"get":{"tags":["CodeSystem"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the code system","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the Oid of the code system","type":"string"},{"name":"authority","in":"query","description":"Gets or sets the authority of the code system","type":"string"},{"name":"url","in":"query","description":"Gets or sets the URL of the code system","type":"string"},{"name":"version","in":"query","description":"Gets or sets the version text of the code system","type":"string"},{"name":"description","in":"query","description":"Gets or sets the human description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodeSystem"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/QuantityObservation/{id}/_export":{"get":{"tags":["QuantityObservation"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"value","in":"query","description":"Gets or sets the observed quantity","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"unitOfMeasure","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ActRelationship/{id}/_export":{"get":{"tags":["ActRelationship"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"sequence","in":"query","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ActRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Observation/{id}/_export":{"get":{"tags":["Observation"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/{id}/_export":{"get":{"tags":["PatientEncounter"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"dischargeDisposition","in":"query","description":"Gets or sets the key of discharge disposition","type":"string"},{"name":"admissionSource","in":"query","description":"Gets or sets the admission source type","type":"string"},{"name":"specialArrangement","in":"query","description":"A list of special arrangements which are to be made to the patient during the encounter","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/_export":{"get":{"tags":["Patient"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ReferenceTerm/{id}/_export":{"get":{"tags":["ReferenceTerm"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the reference term","type":"string"},{"name":"codeSystem","in":"query","description":"Gets or sets the code system identifier","type":"string"},{"name":"name","in":"query","description":"Gets display names associated with the reference term","type":"string"},{"name":"concept","in":"query","description":"Gets or sets the concepts related to this data","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/{id}/_export":{"get":{"tags":["ExtensionType"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"handlerClass","in":"query","description":"Gets or sets the description","type":"string"},{"name":"uri","in":"query","description":"Gets or sets the uri of the extension","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the extension","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ExtensionType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/{id}/_export":{"get":{"tags":["Container"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"capacityQuantity","in":"query","description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"string"},{"name":"diameterQuantity","in":"query","description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"string"},{"name":"heightQuantity","in":"query","description":"Gets or sets the height quantity. The height of the container.","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/{id}/_export":{"get":{"tags":["DeviceEntity"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"manufacturerModelName","in":"query","description":"Gets or sets the manufacturer model name","type":"string"},{"name":"operatingSystemName","in":"query","description":"Gets or sets the operating system name","type":"string"},{"name":"securityDevice","in":"query","description":"Gets or sets the security device key","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/{id}/_export":{"get":{"tags":["UserEntity"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"securityUser","in":"query","description":"Gets or sets the security user key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TextObservation/{id}/_export":{"get":{"tags":["TextObservation"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the textual value","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Place/{id}/_export":{"get":{"tags":["Place"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"isMobile","in":"query","description":"True if location is mobile","type":"boolean"},{"name":"service","in":"query","description":"Gets the services","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailMessage/{id}/_export":{"get":{"tags":["MailMessage"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"body","in":"query","description":"Gets or sets the alert body of the alert.","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the status of the alert.","type":"string","enum":[]},{"name":"from","in":"query","description":"Gets or sets the \"from\" subject if it is a human based message of the alert.","type":"string"},{"name":"fromInfo","in":"query","description":"From Information (string representation)","type":"string"},{"name":"toInfo","in":"query","description":"To information","type":"string"},{"name":"to","in":"query","description":"Legacy property for the \"to\" field (so sync can occur on older tablets)","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets or sets the time this was modified on","type":"string"},{"name":"rcpt","in":"query","description":"The recipient users used for query","type":"string"},{"name":"subject","in":"query","description":"Gets or sets the subject of the alert.","type":"string"},{"name":"mailbox","in":"query","description":"Gets the messages for this mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TemplateDefinition/{id}/_export":{"get":{"tags":["TemplateDefinition"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"name","in":"query","description":"Gets or set the name","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TemplateDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/{id}/_export":{"get":{"tags":["ManufacturedMaterial"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Narrative/{id}/_export":{"get":{"tags":["Narrative"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"versionCode","in":"query","description":"The external version number of the structured document","type":"string"},{"name":"language","in":"query","description":"The language in which the document content is written","type":"string"},{"name":"mime","in":"query","description":"Gets or sets the mime type of the narrative content","type":"string"},{"name":"title","in":"query","description":"The title of the clinical document","type":"string"},{"name":"text","in":"query","description":"Gets or sets the text of the document","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DeviceMailbox/{id}/_export":{"get":{"tags":["DeviceMailbox"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1"]}],"deprecated":false}},"/SubstanceAdministration/{id}/_export":{"get":{"tags":["SubstanceAdministration"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"route","in":"query","description":"Gets or sets the key for route","type":"string"},{"name":"doseUnit","in":"query","description":"Gets or sets the key for dosing unit","type":"string"},{"name":"doseQuantity","in":"query","description":"Gets or sets the amount of substance administered","type":"number"},{"name":"doseSequence","in":"query","description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"string"},{"name":"site","in":"query","description":"Gets or sets the site","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePlan/{id}/_export":{"get":{"tags":["CarePlan"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"title","in":"query","description":"Gets or sets a human title for the care plan","type":"string"},{"name":"pathway","in":"query","description":"Identifies the care pathway identifier which this care plan is generated for","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/{id}/_export":{"get":{"tags":["Mailbox"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Mailbox"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/{id}/_export":{"get":{"tags":["ConceptExtension"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Person/{id}/_export":{"get":{"tags":["Person"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Organization/{id}/_export":{"get":{"tags":["Organization"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"industryConcept","in":"query","description":"Gets or sets the concept key which classifies the industry in which the organization operates","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/{id}/_export":{},"/ConceptRelationship/{id}/_export":{"get":{"tags":["ConceptRelationship"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"targetConcept","in":"query","description":"Gets or sets the target concept identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Relationship type","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Procedure/{id}/_export":{"get":{"tags":["Procedure"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"method","in":"query","description":"Gets or sets te method/technique used to perform the procedure","type":"string"},{"name":"approachSite","in":"query","description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string"},{"name":"targetSite","in":"query","description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ApplicationEntity/{id}/_export":{"get":{"tags":["ApplicationEntity"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"securityApplication","in":"query","description":"Gets or sets the security application","type":"string"},{"name":"softwareName","in":"query","description":"Gets or sets the name of the software","type":"string"},{"name":"vendorName","in":"query","description":"Gets or sets the vendoer name of the software","type":"string"},{"name":"versionName","in":"query","description":"Gets or sets the version of the software","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/{id}/_export":{"get":{"tags":["Concept"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},{"name":"statusConcept","in":"query","description":"Gets or sets the status concept key","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of concept relationships","type":"string"},{"name":"conceptClass","in":"query","description":"Gets or sets the class identifier","type":"string"},{"name":"referenceTerm","in":"query","description":"Gets a list of concept reference terms","type":"string"},{"name":"name","in":"query","description":"Gets the concept names","type":"string"},{"name":"conceptSet","in":"query","description":"Concept sets as identifiers for XML purposes only","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the concept","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/StockLedgerEntry/{id}/_export":{"get":{"tags":["StockLedgerEntry"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"sequence","in":"query","description":"Gets or sets the sequence of this entry in the ledger","type":"string"},{"name":"act","in":"query","description":"Gets or sets the act which caused this ledger entry to be created","type":"string"},{"name":"container","in":"query","description":"Gets or sets the container to which this ledger entry applies","type":"string"},{"name":"material","in":"query","description":"Gets or sets the material to which the ledger entry applies","type":"string"},{"name":"reason","in":"query","description":"Gets or sets the reason for the ledger entry","type":"string"},{"name":"startOfLine","in":"query","description":"Gets or sets the start of line balance (the known balance before the entry was created)","type":"number"},{"name":"quantity","in":"query","description":"Gets or sets the quantity of the current ledger entry","type":"number"},{"name":"createdBy","in":"query","description":"Gets or sets the security principal that was responsible for the cretion of this ledger entry","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the time that this ledger entry was created","type":"string"},{"name":"timestamp","in":"query","description":"Gets or sets the timestamp when the ledger entry applies to","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the modification date of this object entry","type":"string"},{"name":"type","in":"query","description":"Gets or sets the stock ledger entry type","type":"string","enum":["ledger","rollback","purged"]},{"name":"ref","in":"query","description":"If this entry points to another entry, then the pointer to the entry being referenced","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/StockLedgerEntry"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/IdentityDomain/{id}/_export":{"get":{"tags":["IdentityDomain"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the assigning authority","type":"string"},{"name":"domainName","in":"query","description":"Gets or sets the domain name of the assigning authority","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the assigning authority","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the assigning authority","type":"string"},{"name":"url","in":"query","description":"The URL of the assigning authority","type":"string"},{"name":"assigningAuthority","in":"query","description":"Assigning device identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string"},{"name":"identifierClass","in":"query","description":"Gets or sets the identifier classification key","type":"string"},{"name":"validation","in":"query","description":"Gets or sets the validation regex","type":"string"},{"name":"isUnique","in":"query","description":"True if the assigning authority values should be unique","type":"boolean"},{"name":"customValidator","in":"query","description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},{"name":"checkDigitAlgorithm","in":"query","description":"Gets or sets the check digit algorithm","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/IdentityDomain"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/{id}/_export":{"get":{"tags":["Act"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/{id}/_export":{"get":{"tags":["PlaceService"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"serviceConcept","in":"query","description":"Gets or sets the service concept key","type":"string"},{"name":"serviceSchedule","in":"query","description":"The schedule that the service is offered","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PlaceService"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/{id}/_export":{"get":{"tags":["Entity"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DateObservation/{id}/_export":{"get":{"tags":["DateObservation"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"valuePrecision","in":"query","description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePathwayDefinition/{id}/_export":{"get":{"tags":["CarePathwayDefinition"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the care pathway","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the care pathway","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the care pathway","type":"string"},{"name":"eligibility","in":"query","description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},{"name":"enrollment","in":"query","description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},{"name":"encounterTemplate","in":"query","description":"Gets or sets the type of encounter","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptClass/{id}/_export":{"get":{"tags":["ConceptClass"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the concept class","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptClass"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityExtension/{id}/_export":{"get":{"tags":["EntityExtension"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/{id}/_export":{"get":{"tags":["EntityRelationship"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"holder","in":"query","description":"The entity that this relationship targets","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"strength","in":"query","description":"The strength (confidence) of the relationship between source and target","type":"string"},{"name":"quantity","in":"query","description":"Represents the quantity of target in source","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"relationshipRole","in":"query","description":"Association type key","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Protocol/{id}/_export":{"get":{"tags":["Protocol"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the protocol","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the OID","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Protocol"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptReferenceTerm/{id}/_export":{"get":{"tags":["ConceptReferenceTerm"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"term","in":"query","description":"Gets or sets the reference term identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Gets or sets the relationship type identifier","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationshipType/{id}/_export":{"get":{"tags":["ConceptRelationshipType"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the relationship","type":"string"},{"name":"mnemonic","in":"query","description":"The invariant of the relationship type","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationshipType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodedObservation/{id}/_export":{"get":{"tags":["CodedObservation"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptSet/{id}/_export":{"get":{"tags":["ConceptSet"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptSet"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/{id}/_export":{"get":{"tags":["Material"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailboxMailMessage/{id}/_export":{"get":{"tags":["MailboxMailMessage"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/{id}/_export":{"get":{"tags":["Provider"],"summary":"Get the dataset for the specified object","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string"},{"name":"providerSpecialty","in":"query","description":"Gets or sets the provider specialty key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/xsd":{"get":{"tags":[],"summary":"GetSchema","produces":["text/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/XmlSchema"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/":{"options":{"tags":[],"summary":"Options","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ServiceOptions"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"ping":{"tags":[],"summary":"Ping","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":[],"summary":"Performs a patch on all resources in the","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"patchCollection","in":"body","description":"The collection of patches which are to be applied","schema":{"$ref":"#/definitions/PatchCollection"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"One or more of the patch instructions provided does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/CodeSystem":{"options":{"tags":["CodeSystem"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodeSystem"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["CodeSystem"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the code system","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the Oid of the code system","type":"string"},{"name":"authority","in":"query","description":"Gets or sets the authority of the code system","type":"string"},{"name":"url","in":"query","description":"Gets or sets the URL of the code system","type":"string"},{"name":"version","in":"query","description":"Gets or sets the version text of the code system","type":"string"},{"name":"description","in":"query","description":"Gets or sets the human description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodeSystem"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["CodeSystem"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"name","in":"query","description":"Gets or sets the name of the code system","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the Oid of the code system","type":"string"},{"name":"authority","in":"query","description":"Gets or sets the authority of the code system","type":"string"},{"name":"url","in":"query","description":"Gets or sets the URL of the code system","type":"string"},{"name":"version","in":"query","description":"Gets or sets the version text of the code system","type":"string"},{"name":"description","in":"query","description":"Gets or sets the human description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["CodeSystem"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/CodeSystem"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodeSystem"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/QuantityObservation":{"options":{"tags":["QuantityObservation"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["QuantityObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"value","in":"query","description":"Gets or sets the observed quantity","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"unitOfMeasure","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["QuantityObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"value","in":"query","description":"Gets or sets the observed quantity","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"unitOfMeasure","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["QuantityObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/QuantityObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ActRelationship":{"options":{"tags":["ActRelationship"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ActRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["ActRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"sequence","in":"query","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ActRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ActRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"sequence","in":"query","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["ActRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/ActRelationship"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ActRelationship"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Observation":{"options":{"tags":["Observation"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Observation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["Observation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Observation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Observation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter":{"options":{"tags":["PatientEncounter"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["PatientEncounter"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"dischargeDisposition","in":"query","description":"Gets or sets the key of discharge disposition","type":"string"},{"name":"admissionSource","in":"query","description":"Gets or sets the admission source type","type":"string"},{"name":"specialArrangement","in":"query","description":"A list of special arrangements which are to be made to the patient during the encounter","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["PatientEncounter"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"dischargeDisposition","in":"query","description":"Gets or sets the key of discharge disposition","type":"string"},{"name":"admissionSource","in":"query","description":"Gets or sets the admission source type","type":"string"},{"name":"specialArrangement","in":"query","description":"A list of special arrangements which are to be made to the patient during the encounter","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["PatientEncounter"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/PatientEncounter"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient":{"options":{"tags":["Patient"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Patient"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ReferenceTerm":{"options":{"tags":["ReferenceTerm"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["ReferenceTerm"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the reference term","type":"string"},{"name":"codeSystem","in":"query","description":"Gets or sets the code system identifier","type":"string"},{"name":"name","in":"query","description":"Gets display names associated with the reference term","type":"string"},{"name":"concept","in":"query","description":"Gets or sets the concepts related to this data","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ReferenceTerm"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the reference term","type":"string"},{"name":"codeSystem","in":"query","description":"Gets or sets the code system identifier","type":"string"},{"name":"name","in":"query","description":"Gets display names associated with the reference term","type":"string"},{"name":"concept","in":"query","description":"Gets or sets the concepts related to this data","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["ReferenceTerm"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/ReferenceTerm"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ReferenceTerm"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType":{"options":{"tags":["ExtensionType"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ExtensionType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["ExtensionType"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"handlerClass","in":"query","description":"Gets or sets the description","type":"string"},{"name":"uri","in":"query","description":"Gets or sets the uri of the extension","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the extension","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ExtensionType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ExtensionType"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"handlerClass","in":"query","description":"Gets or sets the description","type":"string"},{"name":"uri","in":"query","description":"Gets or sets the uri of the extension","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the extension","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["ExtensionType"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/ExtensionType"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ExtensionType"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container":{"options":{"tags":["Container"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Container"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"capacityQuantity","in":"query","description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"string"},{"name":"diameterQuantity","in":"query","description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"string"},{"name":"heightQuantity","in":"query","description":"Gets or sets the height quantity. The height of the container.","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Container"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"capacityQuantity","in":"query","description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"string"},{"name":"diameterQuantity","in":"query","description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"string"},{"name":"heightQuantity","in":"query","description":"Gets or sets the height quantity. The height of the container.","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Container"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Container"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity":{"options":{"tags":["DeviceEntity"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["DeviceEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"manufacturerModelName","in":"query","description":"Gets or sets the manufacturer model name","type":"string"},{"name":"operatingSystemName","in":"query","description":"Gets or sets the operating system name","type":"string"},{"name":"securityDevice","in":"query","description":"Gets or sets the security device key","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["DeviceEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"manufacturerModelName","in":"query","description":"Gets or sets the manufacturer model name","type":"string"},{"name":"operatingSystemName","in":"query","description":"Gets or sets the operating system name","type":"string"},{"name":"securityDevice","in":"query","description":"Gets or sets the security device key","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["DeviceEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/DeviceEntity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity":{"options":{"tags":["UserEntity"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["UserEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"securityUser","in":"query","description":"Gets or sets the security user key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["UserEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"securityUser","in":"query","description":"Gets or sets the security user key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["UserEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/UserEntity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TextObservation":{"options":{"tags":["TextObservation"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["TextObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the textual value","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["TextObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the textual value","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["TextObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/TextObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Place":{"options":{"tags":["Place"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Place"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"isMobile","in":"query","description":"True if location is mobile","type":"boolean"},{"name":"service","in":"query","description":"Gets the services","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Place"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"isMobile","in":"query","description":"True if location is mobile","type":"boolean"},{"name":"service","in":"query","description":"Gets the services","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Place"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Place"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailMessage":{"options":{"tags":["MailMessage"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["MailMessage"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"body","in":"query","description":"Gets or sets the alert body of the alert.","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the status of the alert.","type":"string","enum":[]},{"name":"from","in":"query","description":"Gets or sets the \"from\" subject if it is a human based message of the alert.","type":"string"},{"name":"fromInfo","in":"query","description":"From Information (string representation)","type":"string"},{"name":"toInfo","in":"query","description":"To information","type":"string"},{"name":"to","in":"query","description":"Legacy property for the \"to\" field (so sync can occur on older tablets)","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets or sets the time this was modified on","type":"string"},{"name":"rcpt","in":"query","description":"The recipient users used for query","type":"string"},{"name":"subject","in":"query","description":"Gets or sets the subject of the alert.","type":"string"},{"name":"mailbox","in":"query","description":"Gets the messages for this mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["MailMessage"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"query","description":"Gets or sets the alert body of the alert.","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the status of the alert.","type":"string","enum":[]},{"name":"from","in":"query","description":"Gets or sets the \"from\" subject if it is a human based message of the alert.","type":"string"},{"name":"fromInfo","in":"query","description":"From Information (string representation)","type":"string"},{"name":"toInfo","in":"query","description":"To information","type":"string"},{"name":"to","in":"query","description":"Legacy property for the \"to\" field (so sync can occur on older tablets)","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets or sets the time this was modified on","type":"string"},{"name":"rcpt","in":"query","description":"The recipient users used for query","type":"string"},{"name":"subject","in":"query","description":"Gets or sets the subject of the alert.","type":"string"},{"name":"mailbox","in":"query","description":"Gets the messages for this mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["MailMessage"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/MailMessage"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailMessage"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TemplateDefinition":{"options":{"tags":["TemplateDefinition"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TemplateDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["TemplateDefinition"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"name","in":"query","description":"Gets or set the name","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TemplateDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["TemplateDefinition"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"name","in":"query","description":"Gets or set the name","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/ManufacturedMaterial":{"options":{"tags":["ManufacturedMaterial"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["ManufacturedMaterial"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ManufacturedMaterial"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["ManufacturedMaterial"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Narrative":{"options":{"tags":["Narrative"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Narrative"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"versionCode","in":"query","description":"The external version number of the structured document","type":"string"},{"name":"language","in":"query","description":"The language in which the document content is written","type":"string"},{"name":"mime","in":"query","description":"Gets or sets the mime type of the narrative content","type":"string"},{"name":"title","in":"query","description":"The title of the clinical document","type":"string"},{"name":"text","in":"query","description":"Gets or sets the text of the document","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["Narrative"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"versionCode","in":"query","description":"The external version number of the structured document","type":"string"},{"name":"language","in":"query","description":"The language in which the document content is written","type":"string"},{"name":"mime","in":"query","description":"Gets or sets the mime type of the narrative content","type":"string"},{"name":"title","in":"query","description":"The title of the clinical document","type":"string"},{"name":"text","in":"query","description":"Gets or sets the text of the document","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Narrative"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Narrative"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DeviceMailbox":{"options":{"tags":["DeviceMailbox"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["DeviceMailbox"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1"]}],"deprecated":false},"head":{"tags":["DeviceMailbox"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/SubstanceAdministration":{"options":{"tags":["SubstanceAdministration"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["SubstanceAdministration"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"route","in":"query","description":"Gets or sets the key for route","type":"string"},{"name":"doseUnit","in":"query","description":"Gets or sets the key for dosing unit","type":"string"},{"name":"doseQuantity","in":"query","description":"Gets or sets the amount of substance administered","type":"number"},{"name":"doseSequence","in":"query","description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"string"},{"name":"site","in":"query","description":"Gets or sets the site","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["SubstanceAdministration"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"route","in":"query","description":"Gets or sets the key for route","type":"string"},{"name":"doseUnit","in":"query","description":"Gets or sets the key for dosing unit","type":"string"},{"name":"doseQuantity","in":"query","description":"Gets or sets the amount of substance administered","type":"number"},{"name":"doseSequence","in":"query","description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"string"},{"name":"site","in":"query","description":"Gets or sets the site","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["SubstanceAdministration"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/SubstanceAdministration"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePlan":{"options":{"tags":["CarePlan"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["CarePlan"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"title","in":"query","description":"Gets or sets a human title for the care plan","type":"string"},{"name":"pathway","in":"query","description":"Identifies the care pathway identifier which this care plan is generated for","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["CarePlan"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"title","in":"query","description":"Gets or sets a human title for the care plan","type":"string"},{"name":"pathway","in":"query","description":"Identifies the care pathway identifier which this care plan is generated for","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["CarePlan"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/CarePlan"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox":{"options":{"tags":["Mailbox"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Mailbox"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Mailbox"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Mailbox"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Mailbox"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Mailbox"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Mailbox"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Mailbox"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension":{"options":{"tags":["ConceptExtension"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["ConceptExtension"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptExtension"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["ConceptExtension"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/ConceptExtension"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptExtension"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Person":{"options":{"tags":["Person"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Person"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["Person"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Person"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Person"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Organization":{"options":{"tags":["Organization"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Organization"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"industryConcept","in":"query","description":"Gets or sets the concept key which classifies the industry in which the organization operates","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Organization"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"industryConcept","in":"query","description":"Gets or sets the concept key which classifies the industry in which the organization operates","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Organization"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Organization"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle":{"options":{"tags":["Bundle"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"head":{"tags":["Bundle"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"modifiedOn","in":"query","description":"Gets the time the bundle was modified","type":"string"},{"name":"correlationSeq","in":"query","description":"Gets or sets the sequence control for this bundle","type":"string"},{"name":"correlationId","in":"query","description":"A unique identifier which correlates this bundle with other bundles that are about the same \"subject\"","type":"string"},{"name":"resource","in":"query","description":"Gets or sets items in the bundle","type":"string"},{"name":"focal","in":"query","description":"Entry into the bundle","type":"string"},{"name":"offset","in":"query","description":"Gets or sets the count in this bundle","type":"number"},{"name":"count","in":"query","description":"Gets or sets the count in this bundle","type":"number"},{"name":"totalResults","in":"query","description":"Gets or sets the total results","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Bundle"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Bundle"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationship":{"options":{"tags":["ConceptRelationship"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["ConceptRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"targetConcept","in":"query","description":"Gets or sets the target concept identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Relationship type","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"targetConcept","in":"query","description":"Gets or sets the target concept identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Relationship type","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["ConceptRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/ConceptRelationship"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationship"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Procedure":{"options":{"tags":["Procedure"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Procedure"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"method","in":"query","description":"Gets or sets te method/technique used to perform the procedure","type":"string"},{"name":"approachSite","in":"query","description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string"},{"name":"targetSite","in":"query","description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["Procedure"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"method","in":"query","description":"Gets or sets te method/technique used to perform the procedure","type":"string"},{"name":"approachSite","in":"query","description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string"},{"name":"targetSite","in":"query","description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Procedure"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Procedure"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ApplicationEntity":{"options":{"tags":["ApplicationEntity"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["ApplicationEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"securityApplication","in":"query","description":"Gets or sets the security application","type":"string"},{"name":"softwareName","in":"query","description":"Gets or sets the name of the software","type":"string"},{"name":"vendorName","in":"query","description":"Gets or sets the vendoer name of the software","type":"string"},{"name":"versionName","in":"query","description":"Gets or sets the version of the software","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ApplicationEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"securityApplication","in":"query","description":"Gets or sets the security application","type":"string"},{"name":"softwareName","in":"query","description":"Gets or sets the name of the software","type":"string"},{"name":"vendorName","in":"query","description":"Gets or sets the vendoer name of the software","type":"string"},{"name":"versionName","in":"query","description":"Gets or sets the version of the software","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["ApplicationEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/ApplicationEntity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept":{"options":{"tags":["Concept"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Concept"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},{"name":"statusConcept","in":"query","description":"Gets or sets the status concept key","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of concept relationships","type":"string"},{"name":"conceptClass","in":"query","description":"Gets or sets the class identifier","type":"string"},{"name":"referenceTerm","in":"query","description":"Gets a list of concept reference terms","type":"string"},{"name":"name","in":"query","description":"Gets the concept names","type":"string"},{"name":"conceptSet","in":"query","description":"Concept sets as identifiers for XML purposes only","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the concept","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Concept"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"mnemonic","in":"query","description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},{"name":"statusConcept","in":"query","description":"Gets or sets the status concept key","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of concept relationships","type":"string"},{"name":"conceptClass","in":"query","description":"Gets or sets the class identifier","type":"string"},{"name":"referenceTerm","in":"query","description":"Gets a list of concept reference terms","type":"string"},{"name":"name","in":"query","description":"Gets the concept names","type":"string"},{"name":"conceptSet","in":"query","description":"Concept sets as identifiers for XML purposes only","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the concept","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Concept"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Concept"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/StockLedgerEntry":{"options":{"tags":["StockLedgerEntry"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/StockLedgerEntry"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["StockLedgerEntry"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"sequence","in":"query","description":"Gets or sets the sequence of this entry in the ledger","type":"string"},{"name":"act","in":"query","description":"Gets or sets the act which caused this ledger entry to be created","type":"string"},{"name":"container","in":"query","description":"Gets or sets the container to which this ledger entry applies","type":"string"},{"name":"material","in":"query","description":"Gets or sets the material to which the ledger entry applies","type":"string"},{"name":"reason","in":"query","description":"Gets or sets the reason for the ledger entry","type":"string"},{"name":"startOfLine","in":"query","description":"Gets or sets the start of line balance (the known balance before the entry was created)","type":"number"},{"name":"quantity","in":"query","description":"Gets or sets the quantity of the current ledger entry","type":"number"},{"name":"createdBy","in":"query","description":"Gets or sets the security principal that was responsible for the cretion of this ledger entry","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the time that this ledger entry was created","type":"string"},{"name":"timestamp","in":"query","description":"Gets or sets the timestamp when the ledger entry applies to","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the modification date of this object entry","type":"string"},{"name":"type","in":"query","description":"Gets or sets the stock ledger entry type","type":"string","enum":["ledger","rollback","purged"]},{"name":"ref","in":"query","description":"If this entry points to another entry, then the pointer to the entry being referenced","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/StockLedgerEntry"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["StockLedgerEntry"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"sequence","in":"query","description":"Gets or sets the sequence of this entry in the ledger","type":"string"},{"name":"act","in":"query","description":"Gets or sets the act which caused this ledger entry to be created","type":"string"},{"name":"container","in":"query","description":"Gets or sets the container to which this ledger entry applies","type":"string"},{"name":"material","in":"query","description":"Gets or sets the material to which the ledger entry applies","type":"string"},{"name":"reason","in":"query","description":"Gets or sets the reason for the ledger entry","type":"string"},{"name":"startOfLine","in":"query","description":"Gets or sets the start of line balance (the known balance before the entry was created)","type":"number"},{"name":"quantity","in":"query","description":"Gets or sets the quantity of the current ledger entry","type":"number"},{"name":"createdBy","in":"query","description":"Gets or sets the security principal that was responsible for the cretion of this ledger entry","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the time that this ledger entry was created","type":"string"},{"name":"timestamp","in":"query","description":"Gets or sets the timestamp when the ledger entry applies to","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the modification date of this object entry","type":"string"},{"name":"type","in":"query","description":"Gets or sets the stock ledger entry type","type":"string","enum":["ledger","rollback","purged"]},{"name":"ref","in":"query","description":"If this entry points to another entry, then the pointer to the entry being referenced","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["StockLedgerEntry"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/StockLedgerEntry"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/StockLedgerEntry"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/IdentityDomain":{"options":{"tags":["IdentityDomain"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/IdentityDomain"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["IdentityDomain"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the assigning authority","type":"string"},{"name":"domainName","in":"query","description":"Gets or sets the domain name of the assigning authority","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the assigning authority","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the assigning authority","type":"string"},{"name":"url","in":"query","description":"The URL of the assigning authority","type":"string"},{"name":"assigningAuthority","in":"query","description":"Assigning device identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string"},{"name":"identifierClass","in":"query","description":"Gets or sets the identifier classification key","type":"string"},{"name":"validation","in":"query","description":"Gets or sets the validation regex","type":"string"},{"name":"isUnique","in":"query","description":"True if the assigning authority values should be unique","type":"boolean"},{"name":"customValidator","in":"query","description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},{"name":"checkDigitAlgorithm","in":"query","description":"Gets or sets the check digit algorithm","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/IdentityDomain"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["IdentityDomain"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"name","in":"query","description":"Gets or sets the name of the assigning authority","type":"string"},{"name":"domainName","in":"query","description":"Gets or sets the domain name of the assigning authority","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the assigning authority","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the assigning authority","type":"string"},{"name":"url","in":"query","description":"The URL of the assigning authority","type":"string"},{"name":"assigningAuthority","in":"query","description":"Assigning device identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string"},{"name":"identifierClass","in":"query","description":"Gets or sets the identifier classification key","type":"string"},{"name":"validation","in":"query","description":"Gets or sets the validation regex","type":"string"},{"name":"isUnique","in":"query","description":"True if the assigning authority values should be unique","type":"boolean"},{"name":"customValidator","in":"query","description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},{"name":"checkDigitAlgorithm","in":"query","description":"Gets or sets the check digit algorithm","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/Act":{"options":{"tags":["Act"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Act"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Act"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Act"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Act"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService":{"options":{"tags":["PlaceService"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PlaceService"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["PlaceService"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"serviceConcept","in":"query","description":"Gets or sets the service concept key","type":"string"},{"name":"serviceSchedule","in":"query","description":"The schedule that the service is offered","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PlaceService"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["PlaceService"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"serviceConcept","in":"query","description":"Gets or sets the service concept key","type":"string"},{"name":"serviceSchedule","in":"query","description":"The schedule that the service is offered","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["PlaceService"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/PlaceService"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PlaceService"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity":{"options":{"tags":["Entity"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Entity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Entity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Entity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Entity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DateObservation":{"options":{"tags":["DateObservation"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["DateObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"valuePrecision","in":"query","description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["DateObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"valuePrecision","in":"query","description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["DateObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/DateObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePathwayDefinition":{"options":{"tags":["CarePathwayDefinition"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["CarePathwayDefinition"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the care pathway","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the care pathway","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the care pathway","type":"string"},{"name":"eligibility","in":"query","description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},{"name":"enrollment","in":"query","description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},{"name":"encounterTemplate","in":"query","description":"Gets or sets the type of encounter","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["CarePathwayDefinition"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the care pathway","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the care pathway","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the care pathway","type":"string"},{"name":"eligibility","in":"query","description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},{"name":"enrollment","in":"query","description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},{"name":"encounterTemplate","in":"query","description":"Gets or sets the type of encounter","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["CarePathwayDefinition"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptClass":{"options":{"tags":["ConceptClass"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptClass"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["ConceptClass"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the concept class","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptClass"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptClass"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"name","in":"query","description":"Gets or sets the name of the concept class","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/EntityExtension":{"options":{"tags":["EntityExtension"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["EntityExtension"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["EntityExtension"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["EntityExtension"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/EntityExtension"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityExtension"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship":{"options":{"tags":["EntityRelationship"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["EntityRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"holder","in":"query","description":"The entity that this relationship targets","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"strength","in":"query","description":"The strength (confidence) of the relationship between source and target","type":"string"},{"name":"quantity","in":"query","description":"Represents the quantity of target in source","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"relationshipRole","in":"query","description":"Association type key","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["EntityRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"holder","in":"query","description":"The entity that this relationship targets","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"strength","in":"query","description":"The strength (confidence) of the relationship between source and target","type":"string"},{"name":"quantity","in":"query","description":"Represents the quantity of target in source","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"relationshipRole","in":"query","description":"Association type key","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["EntityRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/EntityRelationship"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityRelationship"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Protocol":{"options":{"tags":["Protocol"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Protocol"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Protocol"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the protocol","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the OID","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Protocol"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Protocol"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"name","in":"query","description":"Gets or sets the name of the protocol","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the OID","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Protocol"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Protocol"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Protocol"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptReferenceTerm":{"options":{"tags":["ConceptReferenceTerm"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["ConceptReferenceTerm"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"term","in":"query","description":"Gets or sets the reference term identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Gets or sets the relationship type identifier","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptReferenceTerm"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"term","in":"query","description":"Gets or sets the reference term identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Gets or sets the relationship type identifier","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["ConceptReferenceTerm"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationshipType":{"options":{"tags":["ConceptRelationshipType"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationshipType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["ConceptRelationshipType"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the relationship","type":"string"},{"name":"mnemonic","in":"query","description":"The invariant of the relationship type","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationshipType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptRelationshipType"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"name","in":"query","description":"Gets or sets the name of the relationship","type":"string"},{"name":"mnemonic","in":"query","description":"The invariant of the relationship type","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/CodedObservation":{"options":{"tags":["CodedObservation"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["CodedObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["CodedObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["CodedObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/CodedObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptSet":{"options":{"tags":["ConceptSet"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptSet"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["ConceptSet"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptSet"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptSet"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["ConceptSet"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/ConceptSet"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptSet"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material":{"options":{"tags":["Material"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Material"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Material"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Material"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Material"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailboxMailMessage":{"options":{"tags":["MailboxMailMessage"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["MailboxMailMessage"],"summary":"Perform a search (query) for","description":"The search operation calls the database and loads results either from cache or data store. Care should be taken in the number of results retrieved by this operation.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["MailboxMailMessage"],"summary":"Perform a search (query) and return only the headers","description":"The HEAD operation is useful if you wish to determine if the header information for a specific result set has resulted in a change","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["MailboxMailMessage"],"summary":"Creates the resource. If the resource already exists, then a 409 is thrown","description":"This operation is a CREATE ONLY operation, and will throw an error if the operation results in a duplicate. If you are looking for a CREATE OR UPDATE method use the POST with identifier operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/MailboxMailMessage"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider":{"options":{"tags":["Provider"],"summary":"Returns specific options for a single resource","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"get":{"tags":["Provider"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"providerSpecialty","in":"query","description":"Gets or sets the provider specialty key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Provider"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"providerSpecialty","in":"query","description":"Gets or sets the provider specialty key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["Provider"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"body","in":"body","description":"The body of the request","schema":{"$ref":"#/definitions/Provider"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/{id}":{"get":{"tags":["CodeSystem"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the code system","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the Oid of the code system","type":"string"},{"name":"authority","in":"query","description":"Gets or sets the authority of the code system","type":"string"},{"name":"url","in":"query","description":"Gets or sets the URL of the code system","type":"string"},{"name":"version","in":"query","description":"Gets or sets the version text of the code system","type":"string"},{"name":"description","in":"query","description":"Gets or sets the human description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodeSystem"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["CodeSystem"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the code system","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the Oid of the code system","type":"string"},{"name":"authority","in":"query","description":"Gets or sets the authority of the code system","type":"string"},{"name":"url","in":"query","description":"Gets or sets the URL of the code system","type":"string"},{"name":"version","in":"query","description":"Gets or sets the version text of the code system","type":"string"},{"name":"description","in":"query","description":"Gets or sets the human description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["CodeSystem"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["CodeSystem"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/CodeSystem"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodeSystem"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["CodeSystem"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/CodeSystem"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodeSystem"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["CodeSystem"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodeSystem"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/QuantityObservation/{id}":{"get":{"tags":["QuantityObservation"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"value","in":"query","description":"Gets or sets the observed quantity","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"unitOfMeasure","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["QuantityObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"value","in":"query","description":"Gets or sets the observed quantity","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"unitOfMeasure","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["QuantityObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"put":{"tags":["QuantityObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/QuantityObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"post":{"tags":["QuantityObservation"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/QuantityObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"delete":{"tags":["QuantityObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ActRelationship/{id}":{"get":{"tags":["ActRelationship"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"sequence","in":"query","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ActRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ActRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"sequence","in":"query","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["ActRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["ActRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/ActRelationship"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ActRelationship"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["ActRelationship"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/ActRelationship"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ActRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["ActRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ActRelationship"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Observation/{id}":{"get":{"tags":["Observation"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["Observation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Observation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"put":{"tags":["Observation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Observation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"post":{"tags":["Observation"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Observation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"delete":{"tags":["Observation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/{id}":{"get":{"tags":["PatientEncounter"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"dischargeDisposition","in":"query","description":"Gets or sets the key of discharge disposition","type":"string"},{"name":"admissionSource","in":"query","description":"Gets or sets the admission source type","type":"string"},{"name":"specialArrangement","in":"query","description":"A list of special arrangements which are to be made to the patient during the encounter","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["PatientEncounter"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"dischargeDisposition","in":"query","description":"Gets or sets the key of discharge disposition","type":"string"},{"name":"admissionSource","in":"query","description":"Gets or sets the admission source type","type":"string"},{"name":"specialArrangement","in":"query","description":"A list of special arrangements which are to be made to the patient during the encounter","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["PatientEncounter"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"put":{"tags":["PatientEncounter"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/PatientEncounter"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"post":{"tags":["PatientEncounter"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/PatientEncounter"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"delete":{"tags":["PatientEncounter"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Patient"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Patient"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ReferenceTerm/{id}":{"get":{"tags":["ReferenceTerm"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the reference term","type":"string"},{"name":"codeSystem","in":"query","description":"Gets or sets the code system identifier","type":"string"},{"name":"name","in":"query","description":"Gets display names associated with the reference term","type":"string"},{"name":"concept","in":"query","description":"Gets or sets the concepts related to this data","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ReferenceTerm"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the reference term","type":"string"},{"name":"codeSystem","in":"query","description":"Gets or sets the code system identifier","type":"string"},{"name":"name","in":"query","description":"Gets display names associated with the reference term","type":"string"},{"name":"concept","in":"query","description":"Gets or sets the concepts related to this data","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["ReferenceTerm"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["ReferenceTerm"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/ReferenceTerm"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ReferenceTerm"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["ReferenceTerm"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/ReferenceTerm"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["ReferenceTerm"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ReferenceTerm"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/{id}":{"get":{"tags":["ExtensionType"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"handlerClass","in":"query","description":"Gets or sets the description","type":"string"},{"name":"uri","in":"query","description":"Gets or sets the uri of the extension","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the extension","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ExtensionType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ExtensionType"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"handlerClass","in":"query","description":"Gets or sets the description","type":"string"},{"name":"uri","in":"query","description":"Gets or sets the uri of the extension","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the extension","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["ExtensionType"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["ExtensionType"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/ExtensionType"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ExtensionType"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["ExtensionType"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/ExtensionType"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ExtensionType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["ExtensionType"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ExtensionType"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/{id}":{"get":{"tags":["Container"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"capacityQuantity","in":"query","description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"string"},{"name":"diameterQuantity","in":"query","description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"string"},{"name":"heightQuantity","in":"query","description":"Gets or sets the height quantity. The height of the container.","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Container"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"capacityQuantity","in":"query","description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"string"},{"name":"diameterQuantity","in":"query","description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"string"},{"name":"heightQuantity","in":"query","description":"Gets or sets the height quantity. The height of the container.","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Container"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["Container"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Container"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["Container"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Container"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["Container"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/{id}":{"get":{"tags":["DeviceEntity"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"manufacturerModelName","in":"query","description":"Gets or sets the manufacturer model name","type":"string"},{"name":"operatingSystemName","in":"query","description":"Gets or sets the operating system name","type":"string"},{"name":"securityDevice","in":"query","description":"Gets or sets the security device key","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["DeviceEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"manufacturerModelName","in":"query","description":"Gets or sets the manufacturer model name","type":"string"},{"name":"operatingSystemName","in":"query","description":"Gets or sets the operating system name","type":"string"},{"name":"securityDevice","in":"query","description":"Gets or sets the security device key","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["DeviceEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["DeviceEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/DeviceEntity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["DeviceEntity"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/DeviceEntity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["DeviceEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/{id}":{"get":{"tags":["UserEntity"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"securityUser","in":"query","description":"Gets or sets the security user key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["UserEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"securityUser","in":"query","description":"Gets or sets the security user key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["UserEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["UserEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/UserEntity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["UserEntity"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/UserEntity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["UserEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TextObservation/{id}":{"get":{"tags":["TextObservation"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the textual value","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["TextObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the textual value","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["TextObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"put":{"tags":["TextObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/TextObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"post":{"tags":["TextObservation"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/TextObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"delete":{"tags":["TextObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Place/{id}":{"get":{"tags":["Place"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"isMobile","in":"query","description":"True if location is mobile","type":"boolean"},{"name":"service","in":"query","description":"Gets the services","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Place"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"isMobile","in":"query","description":"True if location is mobile","type":"boolean"},{"name":"service","in":"query","description":"Gets the services","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Place"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["Place"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Place"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["Place"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Place"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["Place"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailMessage/{id}":{"get":{"tags":["MailMessage"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"body","in":"query","description":"Gets or sets the alert body of the alert.","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the status of the alert.","type":"string","enum":[]},{"name":"from","in":"query","description":"Gets or sets the \"from\" subject if it is a human based message of the alert.","type":"string"},{"name":"fromInfo","in":"query","description":"From Information (string representation)","type":"string"},{"name":"toInfo","in":"query","description":"To information","type":"string"},{"name":"to","in":"query","description":"Legacy property for the \"to\" field (so sync can occur on older tablets)","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets or sets the time this was modified on","type":"string"},{"name":"rcpt","in":"query","description":"The recipient users used for query","type":"string"},{"name":"subject","in":"query","description":"Gets or sets the subject of the alert.","type":"string"},{"name":"mailbox","in":"query","description":"Gets the messages for this mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["MailMessage"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"body","in":"query","description":"Gets or sets the alert body of the alert.","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the status of the alert.","type":"string","enum":[]},{"name":"from","in":"query","description":"Gets or sets the \"from\" subject if it is a human based message of the alert.","type":"string"},{"name":"fromInfo","in":"query","description":"From Information (string representation)","type":"string"},{"name":"toInfo","in":"query","description":"To information","type":"string"},{"name":"to","in":"query","description":"Legacy property for the \"to\" field (so sync can occur on older tablets)","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets or sets the time this was modified on","type":"string"},{"name":"rcpt","in":"query","description":"The recipient users used for query","type":"string"},{"name":"subject","in":"query","description":"Gets or sets the subject of the alert.","type":"string"},{"name":"mailbox","in":"query","description":"Gets the messages for this mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["MailMessage"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["MailMessage"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/MailMessage"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailMessage"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["MailMessage"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/MailMessage"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["MailMessage"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailMessage"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TemplateDefinition/{id}":{"get":{"tags":["TemplateDefinition"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"name","in":"query","description":"Gets or set the name","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TemplateDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["TemplateDefinition"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"name","in":"query","description":"Gets or set the name","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/ManufacturedMaterial/{id}":{"get":{"tags":["ManufacturedMaterial"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ManufacturedMaterial"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["ManufacturedMaterial"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["ManufacturedMaterial"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["ManufacturedMaterial"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["ManufacturedMaterial"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Narrative/{id}":{"get":{"tags":["Narrative"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"versionCode","in":"query","description":"The external version number of the structured document","type":"string"},{"name":"language","in":"query","description":"The language in which the document content is written","type":"string"},{"name":"mime","in":"query","description":"Gets or sets the mime type of the narrative content","type":"string"},{"name":"title","in":"query","description":"The title of the clinical document","type":"string"},{"name":"text","in":"query","description":"Gets or sets the text of the document","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["Narrative"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"versionCode","in":"query","description":"The external version number of the structured document","type":"string"},{"name":"language","in":"query","description":"The language in which the document content is written","type":"string"},{"name":"mime","in":"query","description":"Gets or sets the mime type of the narrative content","type":"string"},{"name":"title","in":"query","description":"The title of the clinical document","type":"string"},{"name":"text","in":"query","description":"Gets or sets the text of the document","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Narrative"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"put":{"tags":["Narrative"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Narrative"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"post":{"tags":["Narrative"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Narrative"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"delete":{"tags":["Narrative"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DeviceMailbox/{id}":{"get":{"tags":["DeviceMailbox"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1"]}],"deprecated":false},"head":{"tags":["DeviceMailbox"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"delete":{"tags":["DeviceMailbox"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/SubstanceAdministration/{id}":{"get":{"tags":["SubstanceAdministration"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"route","in":"query","description":"Gets or sets the key for route","type":"string"},{"name":"doseUnit","in":"query","description":"Gets or sets the key for dosing unit","type":"string"},{"name":"doseQuantity","in":"query","description":"Gets or sets the amount of substance administered","type":"number"},{"name":"doseSequence","in":"query","description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"string"},{"name":"site","in":"query","description":"Gets or sets the site","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["SubstanceAdministration"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"route","in":"query","description":"Gets or sets the key for route","type":"string"},{"name":"doseUnit","in":"query","description":"Gets or sets the key for dosing unit","type":"string"},{"name":"doseQuantity","in":"query","description":"Gets or sets the amount of substance administered","type":"number"},{"name":"doseSequence","in":"query","description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"string"},{"name":"site","in":"query","description":"Gets or sets the site","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["SubstanceAdministration"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"put":{"tags":["SubstanceAdministration"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/SubstanceAdministration"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"post":{"tags":["SubstanceAdministration"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/SubstanceAdministration"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"delete":{"tags":["SubstanceAdministration"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePlan/{id}":{"get":{"tags":["CarePlan"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"title","in":"query","description":"Gets or sets a human title for the care plan","type":"string"},{"name":"pathway","in":"query","description":"Identifies the care pathway identifier which this care plan is generated for","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["CarePlan"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"title","in":"query","description":"Gets or sets a human title for the care plan","type":"string"},{"name":"pathway","in":"query","description":"Identifies the care pathway identifier which this care plan is generated for","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["CarePlan"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["CarePlan"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/CarePlan"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["CarePlan"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/CarePlan"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["CarePlan"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/{id}":{"get":{"tags":["Mailbox"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Mailbox"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Mailbox"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Mailbox"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["Mailbox"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Mailbox"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Mailbox"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["Mailbox"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Mailbox"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Mailbox"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["Mailbox"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Mailbox"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/{id}":{"get":{"tags":["ConceptExtension"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptExtension"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["ConceptExtension"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["ConceptExtension"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/ConceptExtension"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptExtension"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["ConceptExtension"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/ConceptExtension"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["ConceptExtension"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptExtension"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Person/{id}":{"get":{"tags":["Person"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["Person"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Person"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"put":{"tags":["Person"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Person"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"post":{"tags":["Person"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Person"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"delete":{"tags":["Person"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Organization/{id}":{"get":{"tags":["Organization"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"industryConcept","in":"query","description":"Gets or sets the concept key which classifies the industry in which the organization operates","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Organization"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"industryConcept","in":"query","description":"Gets or sets the concept key which classifies the industry in which the organization operates","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Organization"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["Organization"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Organization"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["Organization"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Organization"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["Organization"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/{id}":{"head":{"tags":["Bundle"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time the bundle was modified","type":"string"},{"name":"correlationSeq","in":"query","description":"Gets or sets the sequence control for this bundle","type":"string"},{"name":"correlationId","in":"query","description":"A unique identifier which correlates this bundle with other bundles that are about the same \"subject\"","type":"string"},{"name":"resource","in":"query","description":"Gets or sets items in the bundle","type":"string"},{"name":"focal","in":"query","description":"Entry into the bundle","type":"string"},{"name":"offset","in":"query","description":"Gets or sets the count in this bundle","type":"number"},{"name":"count","in":"query","description":"Gets or sets the count in this bundle","type":"number"},{"name":"totalResults","in":"query","description":"Gets or sets the total results","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Bundle"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["Bundle"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Bundle"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["Bundle"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Bundle"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["Bundle"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationship/{id}":{"get":{"tags":["ConceptRelationship"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"targetConcept","in":"query","description":"Gets or sets the target concept identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Relationship type","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"targetConcept","in":"query","description":"Gets or sets the target concept identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Relationship type","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["ConceptRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["ConceptRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/ConceptRelationship"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationship"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["ConceptRelationship"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/ConceptRelationship"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["ConceptRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationship"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Procedure/{id}":{"get":{"tags":["Procedure"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"method","in":"query","description":"Gets or sets te method/technique used to perform the procedure","type":"string"},{"name":"approachSite","in":"query","description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string"},{"name":"targetSite","in":"query","description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["Procedure"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"method","in":"query","description":"Gets or sets te method/technique used to perform the procedure","type":"string"},{"name":"approachSite","in":"query","description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string"},{"name":"targetSite","in":"query","description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Procedure"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"put":{"tags":["Procedure"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Procedure"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"post":{"tags":["Procedure"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Procedure"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"delete":{"tags":["Procedure"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ApplicationEntity/{id}":{"get":{"tags":["ApplicationEntity"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"securityApplication","in":"query","description":"Gets or sets the security application","type":"string"},{"name":"softwareName","in":"query","description":"Gets or sets the name of the software","type":"string"},{"name":"vendorName","in":"query","description":"Gets or sets the vendoer name of the software","type":"string"},{"name":"versionName","in":"query","description":"Gets or sets the version of the software","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ApplicationEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"securityApplication","in":"query","description":"Gets or sets the security application","type":"string"},{"name":"softwareName","in":"query","description":"Gets or sets the name of the software","type":"string"},{"name":"vendorName","in":"query","description":"Gets or sets the vendoer name of the software","type":"string"},{"name":"versionName","in":"query","description":"Gets or sets the version of the software","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["ApplicationEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["ApplicationEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/ApplicationEntity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["ApplicationEntity"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/ApplicationEntity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["ApplicationEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/{id}":{"get":{"tags":["Concept"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},{"name":"statusConcept","in":"query","description":"Gets or sets the status concept key","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of concept relationships","type":"string"},{"name":"conceptClass","in":"query","description":"Gets or sets the class identifier","type":"string"},{"name":"referenceTerm","in":"query","description":"Gets a list of concept reference terms","type":"string"},{"name":"name","in":"query","description":"Gets the concept names","type":"string"},{"name":"conceptSet","in":"query","description":"Concept sets as identifiers for XML purposes only","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the concept","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Concept"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},{"name":"statusConcept","in":"query","description":"Gets or sets the status concept key","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of concept relationships","type":"string"},{"name":"conceptClass","in":"query","description":"Gets or sets the class identifier","type":"string"},{"name":"referenceTerm","in":"query","description":"Gets a list of concept reference terms","type":"string"},{"name":"name","in":"query","description":"Gets the concept names","type":"string"},{"name":"conceptSet","in":"query","description":"Concept sets as identifiers for XML purposes only","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the concept","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Concept"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["Concept"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Concept"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["Concept"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Concept"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["Concept"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/StockLedgerEntry/{id}":{"get":{"tags":["StockLedgerEntry"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"sequence","in":"query","description":"Gets or sets the sequence of this entry in the ledger","type":"string"},{"name":"act","in":"query","description":"Gets or sets the act which caused this ledger entry to be created","type":"string"},{"name":"container","in":"query","description":"Gets or sets the container to which this ledger entry applies","type":"string"},{"name":"material","in":"query","description":"Gets or sets the material to which the ledger entry applies","type":"string"},{"name":"reason","in":"query","description":"Gets or sets the reason for the ledger entry","type":"string"},{"name":"startOfLine","in":"query","description":"Gets or sets the start of line balance (the known balance before the entry was created)","type":"number"},{"name":"quantity","in":"query","description":"Gets or sets the quantity of the current ledger entry","type":"number"},{"name":"createdBy","in":"query","description":"Gets or sets the security principal that was responsible for the cretion of this ledger entry","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the time that this ledger entry was created","type":"string"},{"name":"timestamp","in":"query","description":"Gets or sets the timestamp when the ledger entry applies to","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the modification date of this object entry","type":"string"},{"name":"type","in":"query","description":"Gets or sets the stock ledger entry type","type":"string","enum":["ledger","rollback","purged"]},{"name":"ref","in":"query","description":"If this entry points to another entry, then the pointer to the entry being referenced","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/StockLedgerEntry"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["StockLedgerEntry"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"sequence","in":"query","description":"Gets or sets the sequence of this entry in the ledger","type":"string"},{"name":"act","in":"query","description":"Gets or sets the act which caused this ledger entry to be created","type":"string"},{"name":"container","in":"query","description":"Gets or sets the container to which this ledger entry applies","type":"string"},{"name":"material","in":"query","description":"Gets or sets the material to which the ledger entry applies","type":"string"},{"name":"reason","in":"query","description":"Gets or sets the reason for the ledger entry","type":"string"},{"name":"startOfLine","in":"query","description":"Gets or sets the start of line balance (the known balance before the entry was created)","type":"number"},{"name":"quantity","in":"query","description":"Gets or sets the quantity of the current ledger entry","type":"number"},{"name":"createdBy","in":"query","description":"Gets or sets the security principal that was responsible for the cretion of this ledger entry","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the time that this ledger entry was created","type":"string"},{"name":"timestamp","in":"query","description":"Gets or sets the timestamp when the ledger entry applies to","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the modification date of this object entry","type":"string"},{"name":"type","in":"query","description":"Gets or sets the stock ledger entry type","type":"string","enum":["ledger","rollback","purged"]},{"name":"ref","in":"query","description":"If this entry points to another entry, then the pointer to the entry being referenced","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"post":{"tags":["StockLedgerEntry"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/StockLedgerEntry"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/StockLedgerEntry"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/IdentityDomain/{id}":{"get":{"tags":["IdentityDomain"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the assigning authority","type":"string"},{"name":"domainName","in":"query","description":"Gets or sets the domain name of the assigning authority","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the assigning authority","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the assigning authority","type":"string"},{"name":"url","in":"query","description":"The URL of the assigning authority","type":"string"},{"name":"assigningAuthority","in":"query","description":"Assigning device identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string"},{"name":"identifierClass","in":"query","description":"Gets or sets the identifier classification key","type":"string"},{"name":"validation","in":"query","description":"Gets or sets the validation regex","type":"string"},{"name":"isUnique","in":"query","description":"True if the assigning authority values should be unique","type":"boolean"},{"name":"customValidator","in":"query","description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},{"name":"checkDigitAlgorithm","in":"query","description":"Gets or sets the check digit algorithm","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/IdentityDomain"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["IdentityDomain"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the assigning authority","type":"string"},{"name":"domainName","in":"query","description":"Gets or sets the domain name of the assigning authority","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the assigning authority","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the assigning authority","type":"string"},{"name":"url","in":"query","description":"The URL of the assigning authority","type":"string"},{"name":"assigningAuthority","in":"query","description":"Assigning device identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string"},{"name":"identifierClass","in":"query","description":"Gets or sets the identifier classification key","type":"string"},{"name":"validation","in":"query","description":"Gets or sets the validation regex","type":"string"},{"name":"isUnique","in":"query","description":"True if the assigning authority values should be unique","type":"boolean"},{"name":"customValidator","in":"query","description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},{"name":"checkDigitAlgorithm","in":"query","description":"Gets or sets the check digit algorithm","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/Act/{id}":{"get":{"tags":["Act"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Act"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Act"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["Act"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Act"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["Act"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Act"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["Act"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/{id}":{"get":{"tags":["PlaceService"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"serviceConcept","in":"query","description":"Gets or sets the service concept key","type":"string"},{"name":"serviceSchedule","in":"query","description":"The schedule that the service is offered","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PlaceService"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["PlaceService"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"serviceConcept","in":"query","description":"Gets or sets the service concept key","type":"string"},{"name":"serviceSchedule","in":"query","description":"The schedule that the service is offered","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["PlaceService"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["PlaceService"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/PlaceService"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PlaceService"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["PlaceService"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/PlaceService"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PlaceService"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["PlaceService"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PlaceService"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/{id}":{"get":{"tags":["Entity"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Entity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Entity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["Entity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Entity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["Entity"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Entity"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["Entity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DateObservation/{id}":{"get":{"tags":["DateObservation"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"valuePrecision","in":"query","description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["DateObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"valuePrecision","in":"query","description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["DateObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"put":{"tags":["DateObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/DateObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"post":{"tags":["DateObservation"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/DateObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"delete":{"tags":["DateObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePathwayDefinition/{id}":{"get":{"tags":["CarePathwayDefinition"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the care pathway","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the care pathway","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the care pathway","type":"string"},{"name":"eligibility","in":"query","description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},{"name":"enrollment","in":"query","description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},{"name":"encounterTemplate","in":"query","description":"Gets or sets the type of encounter","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["CarePathwayDefinition"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the care pathway","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the care pathway","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the care pathway","type":"string"},{"name":"eligibility","in":"query","description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},{"name":"enrollment","in":"query","description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},{"name":"encounterTemplate","in":"query","description":"Gets or sets the type of encounter","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["CarePathwayDefinition"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["CarePathwayDefinition"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["CarePathwayDefinition"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["CarePathwayDefinition"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptClass/{id}":{"get":{"tags":["ConceptClass"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the concept class","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptClass"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptClass"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the concept class","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/EntityExtension/{id}":{"get":{"tags":["EntityExtension"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["EntityExtension"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["EntityExtension"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["EntityExtension"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/EntityExtension"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityExtension"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["EntityExtension"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/EntityExtension"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["EntityExtension"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityExtension"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/{id}":{"get":{"tags":["EntityRelationship"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"holder","in":"query","description":"The entity that this relationship targets","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"strength","in":"query","description":"The strength (confidence) of the relationship between source and target","type":"string"},{"name":"quantity","in":"query","description":"Represents the quantity of target in source","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"relationshipRole","in":"query","description":"Association type key","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["EntityRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"holder","in":"query","description":"The entity that this relationship targets","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"strength","in":"query","description":"The strength (confidence) of the relationship between source and target","type":"string"},{"name":"quantity","in":"query","description":"Represents the quantity of target in source","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"relationshipRole","in":"query","description":"Association type key","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["EntityRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["EntityRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/EntityRelationship"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityRelationship"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["EntityRelationship"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/EntityRelationship"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["EntityRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityRelationship"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Protocol/{id}":{"get":{"tags":["Protocol"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the protocol","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the OID","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Protocol"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Protocol"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the protocol","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the OID","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Protocol"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"put":{"tags":["Protocol"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Protocol"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Protocol"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"post":{"tags":["Protocol"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Protocol"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Protocol"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"delete":{"tags":["Protocol"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Protocol"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptReferenceTerm/{id}":{"get":{"tags":["ConceptReferenceTerm"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"term","in":"query","description":"Gets or sets the reference term identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Gets or sets the relationship type identifier","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptReferenceTerm"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"term","in":"query","description":"Gets or sets the reference term identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Gets or sets the relationship type identifier","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["ConceptReferenceTerm"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["ConceptReferenceTerm"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["ConceptReferenceTerm"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["ConceptReferenceTerm"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationshipType/{id}":{"get":{"tags":["ConceptRelationshipType"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the relationship","type":"string"},{"name":"mnemonic","in":"query","description":"The invariant of the relationship type","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationshipType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptRelationshipType"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the relationship","type":"string"},{"name":"mnemonic","in":"query","description":"The invariant of the relationship type","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/CodedObservation/{id}":{"get":{"tags":["CodedObservation"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"head":{"tags":["CodedObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["CodedObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"put":{"tags":["CodedObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/CodedObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"post":{"tags":["CodedObservation"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/CodedObservation"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"delete":{"tags":["CodedObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptSet/{id}":{"get":{"tags":["ConceptSet"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptSet"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["ConceptSet"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["ConceptSet"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["ConceptSet"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/ConceptSet"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptSet"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["ConceptSet"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/ConceptSet"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptSet"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["ConceptSet"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptSet"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/{id}":{"get":{"tags":["Material"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Material"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Material"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["Material"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Material"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["Material"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Material"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["Material"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailboxMailMessage/{id}":{"get":{"tags":["MailboxMailMessage"],"summary":"Retrieves the current version of the specified resource","description":"This method will first use cache to locate the most recent copy before searching the database. It is recommended to use this method rather than a query to Resource?id={id}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["MailboxMailMessage"],"summary":"Retrieves only the metadata of the specified resource","description":"The metadata for the most recent version of this resource includes the last modified time, the e-tag, etc.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["MailboxMailMessage"],"summary":"Updates the specified resource according to the instructions in the PATCH file","description":"The PATCH operation allows for partial updating of a resource.\r\n            \r\n             This method must be used in conjunction with an If-Match header indicating the version that you would like apply the patch against.\r\n            \r\n             The server will load the most recent version and compre the version code with If-Match, if the match is successful the instructions in the PATCH are applied to the loaded version.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["MailboxMailMessage"],"summary":"Updates the specified resource. If the resource does not exist than a 404 is thrown, if there is a conflict (such a mismatch of data) a 409 is thrown","description":"This operation will update an existing resource on the server such that the data in the database exactly matches the data passed via the API.\r\n            \r\n             Note: If you post an incomplete object (such as one missing identifiers, or addresses) then the current resource will have those attributes removed. For partial updates, use the PATCH operation instead.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/MailboxMailMessage"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["MailboxMailMessage"],"summary":"Creates or updates a resource. That is, creates the resource if it does not exist, or updates it if it does","description":"This method will attempt to update the resource if it exists (a-la PUT style) however, if a PUT fails the operation will create (a-la POST)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/MailboxMailMessage"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["MailboxMailMessage"],"summary":"Deletes the specified resource from the server","description":"This operation either logically or permanently deletes the identified resource so that it no longer appears in general searches. The method of deletion is controlled by the","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/{id}":{"get":{"tags":["Provider"],"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}","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object which should be retrieved","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"providerSpecialty","in":"query","description":"Gets or sets the provider specialty key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"head":{"tags":["Provider"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be retrieved","type":"string"},{"name":"providerSpecialty","in":"query","description":"Gets or sets the provider specialty key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false},"patch":{"tags":["Provider"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be patched","type":"string"},{"name":"body","in":"body","description":"The patch body which contains update instructions on the object referenced by","schema":{"$ref":"#/definitions/Patch"}}],"responses":{"204":{"description":"There is not response for this method"},"409":{"description":"The patch submitted does not match the current version of the object being patched","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"put":{"tags":["Provider"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be updated","type":"string"},{"name":"body","in":"body","description":"The new contents of the resource to be updated","schema":{"$ref":"#/definitions/Provider"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"post":{"tags":["Provider"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be created or updated","type":"string"},{"name":"resource","in":"body","description":"The resource which is to be created or updated","schema":{"$ref":"#/definitions/Provider"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["Provider"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to be deleted","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"409":{"description":"There is a conflict in the update request (version mismatch)","schema":{"$ref":"#/definitions/RestServiceFault"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/QuantityObservation/{id}/_history":{"get":{"tags":["QuantityObservation"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"value","in":"query","description":"Gets or sets the observed quantity","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"unitOfMeasure","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Observation/{id}/_history":{"get":{"tags":["Observation"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/{id}/_history":{"get":{"tags":["PatientEncounter"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"dischargeDisposition","in":"query","description":"Gets or sets the key of discharge disposition","type":"string"},{"name":"admissionSource","in":"query","description":"Gets or sets the admission source type","type":"string"},{"name":"specialArrangement","in":"query","description":"A list of special arrangements which are to be made to the patient during the encounter","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Container/{id}/_history":{"get":{"tags":["Container"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"capacityQuantity","in":"query","description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"string"},{"name":"diameterQuantity","in":"query","description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"string"},{"name":"heightQuantity","in":"query","description":"Gets or sets the height quantity. The height of the container.","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/{id}/_history":{"get":{"tags":["DeviceEntity"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"manufacturerModelName","in":"query","description":"Gets or sets the manufacturer model name","type":"string"},{"name":"operatingSystemName","in":"query","description":"Gets or sets the operating system name","type":"string"},{"name":"securityDevice","in":"query","description":"Gets or sets the security device key","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/{id}/_history":{"get":{"tags":["UserEntity"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"securityUser","in":"query","description":"Gets or sets the security user key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TextObservation/{id}/_history":{"get":{"tags":["TextObservation"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the textual value","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Place/{id}/_history":{"get":{"tags":["Place"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"isMobile","in":"query","description":"True if location is mobile","type":"boolean"},{"name":"service","in":"query","description":"Gets the services","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/{id}/_history":{"get":{"tags":["ManufacturedMaterial"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Narrative/{id}/_history":{"get":{"tags":["Narrative"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"versionCode","in":"query","description":"The external version number of the structured document","type":"string"},{"name":"language","in":"query","description":"The language in which the document content is written","type":"string"},{"name":"mime","in":"query","description":"Gets or sets the mime type of the narrative content","type":"string"},{"name":"title","in":"query","description":"The title of the clinical document","type":"string"},{"name":"text","in":"query","description":"Gets or sets the text of the document","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/SubstanceAdministration/{id}/_history":{"get":{"tags":["SubstanceAdministration"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"route","in":"query","description":"Gets or sets the key for route","type":"string"},{"name":"doseUnit","in":"query","description":"Gets or sets the key for dosing unit","type":"string"},{"name":"doseQuantity","in":"query","description":"Gets or sets the amount of substance administered","type":"number"},{"name":"doseSequence","in":"query","description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"string"},{"name":"site","in":"query","description":"Gets or sets the site","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePlan/{id}/_history":{"get":{"tags":["CarePlan"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"title","in":"query","description":"Gets or sets a human title for the care plan","type":"string"},{"name":"pathway","in":"query","description":"Identifies the care pathway identifier which this care plan is generated for","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Person/{id}/_history":{"get":{"tags":["Person"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Organization/{id}/_history":{"get":{"tags":["Organization"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"industryConcept","in":"query","description":"Gets or sets the concept key which classifies the industry in which the organization operates","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Procedure/{id}/_history":{"get":{"tags":["Procedure"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"method","in":"query","description":"Gets or sets te method/technique used to perform the procedure","type":"string"},{"name":"approachSite","in":"query","description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string"},{"name":"targetSite","in":"query","description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ApplicationEntity/{id}/_history":{"get":{"tags":["ApplicationEntity"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"securityApplication","in":"query","description":"Gets or sets the security application","type":"string"},{"name":"softwareName","in":"query","description":"Gets or sets the name of the software","type":"string"},{"name":"vendorName","in":"query","description":"Gets or sets the vendoer name of the software","type":"string"},{"name":"versionName","in":"query","description":"Gets or sets the version of the software","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/{id}/_history":{"get":{"tags":["Concept"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},{"name":"statusConcept","in":"query","description":"Gets or sets the status concept key","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of concept relationships","type":"string"},{"name":"conceptClass","in":"query","description":"Gets or sets the class identifier","type":"string"},{"name":"referenceTerm","in":"query","description":"Gets a list of concept reference terms","type":"string"},{"name":"name","in":"query","description":"Gets the concept names","type":"string"},{"name":"conceptSet","in":"query","description":"Concept sets as identifiers for XML purposes only","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the concept","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/{id}/_history":{"get":{"tags":["Act"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/{id}/_history":{"get":{"tags":["Entity"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DateObservation/{id}/_history":{"get":{"tags":["DateObservation"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"valuePrecision","in":"query","description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CodedObservation/{id}/_history":{"get":{"tags":["CodedObservation"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Material/{id}/_history":{"get":{"tags":["Material"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/{id}/_history":{"get":{"tags":["Provider"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource to retrieve","type":"string"},{"name":"_since","in":"query","description":"The last version of the object that should be returned","type":"string","required":false},{"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","type":"string","required":false},{"name":"providerSpecialty","in":"query","description":"Gets or sets the provider specialty key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/{id}/$diff":{"post":{"tags":["CodeSystem"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/{id}/$tag":{"post":{"tags":["CodeSystem"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/{id}/$validate":{"post":{"tags":["CodeSystem"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/QuantityObservation/{id}/$diff":{"post":{"tags":["QuantityObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/QuantityObservation/{id}/$tag":{"post":{"tags":["QuantityObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/QuantityObservation/{id}/$validate":{"post":{"tags":["QuantityObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ActRelationship/{id}/$diff":{"post":{"tags":["ActRelationship"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ActRelationship/{id}/$tag":{"post":{"tags":["ActRelationship"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ActRelationship/{id}/$validate":{"post":{"tags":["ActRelationship"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Observation/{id}/$diff":{"post":{"tags":["Observation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Observation/{id}/$tag":{"post":{"tags":["Observation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Observation/{id}/$validate":{"post":{"tags":["Observation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/{id}/$diff":{"post":{"tags":["PatientEncounter"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/{id}/$tag":{"post":{"tags":["PatientEncounter"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/{id}/$validate":{"post":{"tags":["PatientEncounter"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/$diff":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/$carepath-recompute":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/$tag":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/$analyze":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/$carepath-unenroll":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/$match":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/$generate-careplan":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/$validate":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/$carepath-eligibilty":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/$carepath-enroll":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/$match-reset":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ReferenceTerm/{id}/$diff":{"post":{"tags":["ReferenceTerm"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ReferenceTerm/{id}/$tag":{"post":{"tags":["ReferenceTerm"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ReferenceTerm/{id}/$validate":{"post":{"tags":["ReferenceTerm"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/{id}/$diff":{"post":{"tags":["ExtensionType"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/{id}/$tag":{"post":{"tags":["ExtensionType"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/{id}/$validate":{"post":{"tags":["ExtensionType"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/{id}/$diff":{"post":{"tags":["Container"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/{id}/$tag":{"post":{"tags":["Container"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/{id}/$validate":{"post":{"tags":["Container"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/{id}/$reconcile":{"post":{"tags":["Container"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/{id}/$diff":{"post":{"tags":["DeviceEntity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/{id}/$tag":{"post":{"tags":["DeviceEntity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/{id}/$validate":{"post":{"tags":["DeviceEntity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/{id}/$diff":{"post":{"tags":["UserEntity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/{id}/$tag":{"post":{"tags":["UserEntity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/{id}/$validate":{"post":{"tags":["UserEntity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TextObservation/{id}/$diff":{"post":{"tags":["TextObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/TextObservation/{id}/$tag":{"post":{"tags":["TextObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/TextObservation/{id}/$validate":{"post":{"tags":["TextObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Place/{id}/$diff":{"post":{"tags":["Place"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Place/{id}/$tag":{"post":{"tags":["Place"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Place/{id}/$validate":{"post":{"tags":["Place"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailMessage/{id}/$diff":{"post":{"tags":["MailMessage"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailMessage/{id}/$tag":{"post":{"tags":["MailMessage"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TemplateDefinition/{id}/$diff":{},"/TemplateDefinition/{id}/$tag":{},"/TemplateDefinition/{id}/$validate":{},"/ManufacturedMaterial/{id}/$diff":{"post":{"tags":["ManufacturedMaterial"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/{id}/$tag":{"post":{"tags":["ManufacturedMaterial"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/{id}/$validate":{"post":{"tags":["ManufacturedMaterial"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Narrative/{id}/$diff":{"post":{"tags":["Narrative"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Narrative/{id}/$tag":{"post":{"tags":["Narrative"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Narrative/{id}/$validate":{"post":{"tags":["Narrative"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DeviceMailbox/{id}/${operationName}":{},"/SubstanceAdministration/{id}/$diff":{"post":{"tags":["SubstanceAdministration"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/SubstanceAdministration/{id}/$tag":{"post":{"tags":["SubstanceAdministration"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/SubstanceAdministration/{id}/$validate":{"post":{"tags":["SubstanceAdministration"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePlan/{id}/$diff":{"post":{"tags":["CarePlan"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CarePlan/{id}/$tag":{"post":{"tags":["CarePlan"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CarePlan/{id}/$validate":{"post":{"tags":["CarePlan"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/{id}/$diff":{"post":{"tags":["Mailbox"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/{id}/$tag":{"post":{"tags":["Mailbox"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/{id}/$flag-mail":{"post":{"tags":["Mailbox"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/{id}/$move-mail":{"post":{"tags":["Mailbox"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/{id}/$diff":{"post":{"tags":["ConceptExtension"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/{id}/$tag":{"post":{"tags":["ConceptExtension"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/{id}/$validate":{"post":{"tags":["ConceptExtension"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Person/{id}/$diff":{"post":{"tags":["Person"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Person/{id}/$tag":{"post":{"tags":["Person"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Person/{id}/$validate":{"post":{"tags":["Person"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Organization/{id}/$diff":{"post":{"tags":["Organization"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Organization/{id}/$tag":{"post":{"tags":["Organization"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Organization/{id}/$validate":{"post":{"tags":["Organization"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/{id}/$diff":{"post":{"tags":["Bundle"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/{id}/$tag":{"post":{"tags":["Bundle"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/{id}/$analyze":{"post":{"tags":["Bundle"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/{id}/$validate":{"post":{"tags":["Bundle"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationship/{id}/$diff":{"post":{"tags":["ConceptRelationship"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationship/{id}/$tag":{"post":{"tags":["ConceptRelationship"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationship/{id}/$validate":{"post":{"tags":["ConceptRelationship"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Procedure/{id}/$diff":{"post":{"tags":["Procedure"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Procedure/{id}/$tag":{"post":{"tags":["Procedure"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Procedure/{id}/$validate":{"post":{"tags":["Procedure"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ApplicationEntity/{id}/$diff":{"post":{"tags":["ApplicationEntity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ApplicationEntity/{id}/$tag":{"post":{"tags":["ApplicationEntity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ApplicationEntity/{id}/$validate":{"post":{"tags":["ApplicationEntity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/{id}/$diff":{"post":{"tags":["Concept"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/{id}/$tag":{"post":{"tags":["Concept"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/{id}/$validate":{"post":{"tags":["Concept"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/StockLedgerEntry/{id}/$diff":{"post":{"tags":["StockLedgerEntry"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/StockLedgerEntry/{id}/$tag":{"post":{"tags":["StockLedgerEntry"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/IdentityDomain/{id}/$diff":{},"/IdentityDomain/{id}/$tag":{},"/IdentityDomain/{id}/$validate":{},"/Act/{id}/$diff":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/{id}/$tag":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/{id}/$analyze":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/{id}/$alter-policy":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/{id}/$validate":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/{id}/$diff":{"post":{"tags":["PlaceService"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/{id}/$tag":{"post":{"tags":["PlaceService"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/{id}/$validate":{"post":{"tags":["PlaceService"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/{id}/$diff":{"post":{"tags":["Entity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/{id}/$tag":{"post":{"tags":["Entity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/{id}/$alter-policy":{"post":{"tags":["Entity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/{id}/$validate":{"post":{"tags":["Entity"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DateObservation/{id}/$diff":{"post":{"tags":["DateObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DateObservation/{id}/$tag":{"post":{"tags":["DateObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DateObservation/{id}/$validate":{"post":{"tags":["DateObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePathwayDefinition/{id}/$diff":{"post":{"tags":["CarePathwayDefinition"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CarePathwayDefinition/{id}/$tag":{"post":{"tags":["CarePathwayDefinition"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CarePathwayDefinition/{id}/$validate":{"post":{"tags":["CarePathwayDefinition"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptClass/{id}/$diff":{},"/ConceptClass/{id}/$tag":{},"/ConceptClass/{id}/$validate":{},"/EntityExtension/{id}/$diff":{"post":{"tags":["EntityExtension"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityExtension/{id}/$tag":{"post":{"tags":["EntityExtension"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityExtension/{id}/$validate":{"post":{"tags":["EntityExtension"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/{id}/$diff":{"post":{"tags":["EntityRelationship"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/{id}/$tag":{"post":{"tags":["EntityRelationship"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/{id}/$validate":{"post":{"tags":["EntityRelationship"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Protocol/{id}/$diff":{"post":{"tags":["Protocol"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Protocol/{id}/$tag":{"post":{"tags":["Protocol"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Protocol/{id}/$validate":{"post":{"tags":["Protocol"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptReferenceTerm/{id}/$diff":{"post":{"tags":["ConceptReferenceTerm"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptReferenceTerm/{id}/$tag":{"post":{"tags":["ConceptReferenceTerm"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptReferenceTerm/{id}/$validate":{"post":{"tags":["ConceptReferenceTerm"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationshipType/{id}/$diff":{},"/ConceptRelationshipType/{id}/$tag":{},"/ConceptRelationshipType/{id}/$validate":{},"/CodedObservation/{id}/$diff":{"post":{"tags":["CodedObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CodedObservation/{id}/$tag":{"post":{"tags":["CodedObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CodedObservation/{id}/$validate":{"post":{"tags":["CodedObservation"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptSet/{id}/$diff":{"post":{"tags":["ConceptSet"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/{id}/$tag":{"post":{"tags":["ConceptSet"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/{id}/$expand":{"post":{"tags":["ConceptSet"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/{id}/$validate":{"post":{"tags":["ConceptSet"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/{id}/$diff":{"post":{"tags":["Material"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/{id}/$tag":{"post":{"tags":["Material"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/{id}/$validate":{"post":{"tags":["Material"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailboxMailMessage/{id}/$diff":{"post":{"tags":["MailboxMailMessage"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailboxMailMessage/{id}/$tag":{"post":{"tags":["MailboxMailMessage"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/{id}/$diff":{"post":{"tags":["Provider"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/{id}/$tag":{"post":{"tags":["Provider"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/{id}/$validate":{"post":{"tags":["Provider"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The ID of the object which scopes the operation","type":"string"},{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/QuantityObservation/{id}/_history/{versionId}":{"get":{"tags":["QuantityObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"value","in":"query","description":"Gets or sets the observed quantity","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"unitOfMeasure","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Observation/{id}/_history/{versionId}":{"get":{"tags":["Observation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/{id}/_history/{versionId}":{"get":{"tags":["PatientEncounter"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"dischargeDisposition","in":"query","description":"Gets or sets the key of discharge disposition","type":"string"},{"name":"admissionSource","in":"query","description":"Gets or sets the admission source type","type":"string"},{"name":"specialArrangement","in":"query","description":"A list of special arrangements which are to be made to the patient during the encounter","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Container/{id}/_history/{versionId}":{"get":{"tags":["Container"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"capacityQuantity","in":"query","description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"string"},{"name":"diameterQuantity","in":"query","description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"string"},{"name":"heightQuantity","in":"query","description":"Gets or sets the height quantity. The height of the container.","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/{id}/_history/{versionId}":{"get":{"tags":["DeviceEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"manufacturerModelName","in":"query","description":"Gets or sets the manufacturer model name","type":"string"},{"name":"operatingSystemName","in":"query","description":"Gets or sets the operating system name","type":"string"},{"name":"securityDevice","in":"query","description":"Gets or sets the security device key","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/{id}/_history/{versionId}":{"get":{"tags":["UserEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"securityUser","in":"query","description":"Gets or sets the security user key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TextObservation/{id}/_history/{versionId}":{"get":{"tags":["TextObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the textual value","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Place/{id}/_history/{versionId}":{"get":{"tags":["Place"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"isMobile","in":"query","description":"True if location is mobile","type":"boolean"},{"name":"service","in":"query","description":"Gets the services","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/{id}/_history/{versionId}":{"get":{"tags":["ManufacturedMaterial"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Narrative/{id}/_history/{versionId}":{"get":{"tags":["Narrative"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"versionCode","in":"query","description":"The external version number of the structured document","type":"string"},{"name":"language","in":"query","description":"The language in which the document content is written","type":"string"},{"name":"mime","in":"query","description":"Gets or sets the mime type of the narrative content","type":"string"},{"name":"title","in":"query","description":"The title of the clinical document","type":"string"},{"name":"text","in":"query","description":"Gets or sets the text of the document","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/SubstanceAdministration/{id}/_history/{versionId}":{"get":{"tags":["SubstanceAdministration"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"route","in":"query","description":"Gets or sets the key for route","type":"string"},{"name":"doseUnit","in":"query","description":"Gets or sets the key for dosing unit","type":"string"},{"name":"doseQuantity","in":"query","description":"Gets or sets the amount of substance administered","type":"number"},{"name":"doseSequence","in":"query","description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"string"},{"name":"site","in":"query","description":"Gets or sets the site","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePlan/{id}/_history/{versionId}":{"get":{"tags":["CarePlan"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"title","in":"query","description":"Gets or sets a human title for the care plan","type":"string"},{"name":"pathway","in":"query","description":"Identifies the care pathway identifier which this care plan is generated for","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Person/{id}/_history/{versionId}":{"get":{"tags":["Person"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Organization/{id}/_history/{versionId}":{"get":{"tags":["Organization"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"industryConcept","in":"query","description":"Gets or sets the concept key which classifies the industry in which the organization operates","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Procedure/{id}/_history/{versionId}":{"get":{"tags":["Procedure"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"method","in":"query","description":"Gets or sets te method/technique used to perform the procedure","type":"string"},{"name":"approachSite","in":"query","description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string"},{"name":"targetSite","in":"query","description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ApplicationEntity/{id}/_history/{versionId}":{"get":{"tags":["ApplicationEntity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"securityApplication","in":"query","description":"Gets or sets the security application","type":"string"},{"name":"softwareName","in":"query","description":"Gets or sets the name of the software","type":"string"},{"name":"vendorName","in":"query","description":"Gets or sets the vendoer name of the software","type":"string"},{"name":"versionName","in":"query","description":"Gets or sets the version of the software","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/{id}/_history/{versionId}":{"get":{"tags":["Concept"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},{"name":"statusConcept","in":"query","description":"Gets or sets the status concept key","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of concept relationships","type":"string"},{"name":"conceptClass","in":"query","description":"Gets or sets the class identifier","type":"string"},{"name":"referenceTerm","in":"query","description":"Gets a list of concept reference terms","type":"string"},{"name":"name","in":"query","description":"Gets the concept names","type":"string"},{"name":"conceptSet","in":"query","description":"Concept sets as identifiers for XML purposes only","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the concept","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/{id}/_history/{versionId}":{"get":{"tags":["Act"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/{id}/_history/{versionId}":{"get":{"tags":["Entity"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DateObservation/{id}/_history/{versionId}":{"get":{"tags":["DateObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"valuePrecision","in":"query","description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CodedObservation/{id}/_history/{versionId}":{"get":{"tags":["CodedObservation"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Material/{id}/_history/{versionId}":{"get":{"tags":["Material"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/{id}/_history/{versionId}":{"get":{"tags":["Provider"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved","type":"string"},{"name":"versionId","in":"path","description":"The version of the resource to retrieve","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","type":"string","required":false},{"name":"providerSpecialty","in":"query","description":"Gets or sets the provider specialty key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/{id}/_code":{"get":{"tags":["CodeSystem"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the code system","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the Oid of the code system","type":"string"},{"name":"authority","in":"query","description":"Gets or sets the authority of the code system","type":"string"},{"name":"url","in":"query","description":"Gets or sets the URL of the code system","type":"string"},{"name":"version","in":"query","description":"Gets or sets the version text of the code system","type":"string"},{"name":"description","in":"query","description":"Gets or sets the human description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodeSystem"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/QuantityObservation/{id}/_code":{"get":{"tags":["QuantityObservation"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"value","in":"query","description":"Gets or sets the observed quantity","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"unitOfMeasure","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ActRelationship/{id}/_code":{"get":{"tags":["ActRelationship"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"sequence","in":"query","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ActRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Observation/{id}/_code":{"get":{"tags":["Observation"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/{id}/_code":{"get":{"tags":["PatientEncounter"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"dischargeDisposition","in":"query","description":"Gets or sets the key of discharge disposition","type":"string"},{"name":"admissionSource","in":"query","description":"Gets or sets the admission source type","type":"string"},{"name":"specialArrangement","in":"query","description":"A list of special arrangements which are to be made to the patient during the encounter","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ReferenceTerm/{id}/_code":{"get":{"tags":["ReferenceTerm"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the reference term","type":"string"},{"name":"codeSystem","in":"query","description":"Gets or sets the code system identifier","type":"string"},{"name":"name","in":"query","description":"Gets display names associated with the reference term","type":"string"},{"name":"concept","in":"query","description":"Gets or sets the concepts related to this data","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/{id}/_code":{"get":{"tags":["ExtensionType"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"handlerClass","in":"query","description":"Gets or sets the description","type":"string"},{"name":"uri","in":"query","description":"Gets or sets the uri of the extension","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the extension","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ExtensionType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/{id}/_code":{"get":{"tags":["Container"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"capacityQuantity","in":"query","description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"string"},{"name":"diameterQuantity","in":"query","description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"string"},{"name":"heightQuantity","in":"query","description":"Gets or sets the height quantity. The height of the container.","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/{id}/_code":{"get":{"tags":["DeviceEntity"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"manufacturerModelName","in":"query","description":"Gets or sets the manufacturer model name","type":"string"},{"name":"operatingSystemName","in":"query","description":"Gets or sets the operating system name","type":"string"},{"name":"securityDevice","in":"query","description":"Gets or sets the security device key","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/{id}/_code":{"get":{"tags":["UserEntity"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"securityUser","in":"query","description":"Gets or sets the security user key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TextObservation/{id}/_code":{"get":{"tags":["TextObservation"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the textual value","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Place/{id}/_code":{"get":{"tags":["Place"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"isMobile","in":"query","description":"True if location is mobile","type":"boolean"},{"name":"service","in":"query","description":"Gets the services","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailMessage/{id}/_code":{"get":{"tags":["MailMessage"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"body","in":"query","description":"Gets or sets the alert body of the alert.","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the status of the alert.","type":"string","enum":[]},{"name":"from","in":"query","description":"Gets or sets the \"from\" subject if it is a human based message of the alert.","type":"string"},{"name":"fromInfo","in":"query","description":"From Information (string representation)","type":"string"},{"name":"toInfo","in":"query","description":"To information","type":"string"},{"name":"to","in":"query","description":"Legacy property for the \"to\" field (so sync can occur on older tablets)","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets or sets the time this was modified on","type":"string"},{"name":"rcpt","in":"query","description":"The recipient users used for query","type":"string"},{"name":"subject","in":"query","description":"Gets or sets the subject of the alert.","type":"string"},{"name":"mailbox","in":"query","description":"Gets the messages for this mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TemplateDefinition/{id}/_code":{"get":{"tags":["TemplateDefinition"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"name","in":"query","description":"Gets or set the name","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TemplateDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/{id}/_code":{"get":{"tags":["ManufacturedMaterial"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Narrative/{id}/_code":{"get":{"tags":["Narrative"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"versionCode","in":"query","description":"The external version number of the structured document","type":"string"},{"name":"language","in":"query","description":"The language in which the document content is written","type":"string"},{"name":"mime","in":"query","description":"Gets or sets the mime type of the narrative content","type":"string"},{"name":"title","in":"query","description":"The title of the clinical document","type":"string"},{"name":"text","in":"query","description":"Gets or sets the text of the document","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DeviceMailbox/{id}/_code":{"get":{"tags":["DeviceMailbox"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1"]}],"deprecated":false}},"/SubstanceAdministration/{id}/_code":{"get":{"tags":["SubstanceAdministration"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"route","in":"query","description":"Gets or sets the key for route","type":"string"},{"name":"doseUnit","in":"query","description":"Gets or sets the key for dosing unit","type":"string"},{"name":"doseQuantity","in":"query","description":"Gets or sets the amount of substance administered","type":"number"},{"name":"doseSequence","in":"query","description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"string"},{"name":"site","in":"query","description":"Gets or sets the site","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePlan/{id}/_code":{"get":{"tags":["CarePlan"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"title","in":"query","description":"Gets or sets a human title for the care plan","type":"string"},{"name":"pathway","in":"query","description":"Identifies the care pathway identifier which this care plan is generated for","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/{id}/_code":{"get":{"tags":["Mailbox"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Mailbox"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/{id}/_code":{"get":{"tags":["ConceptExtension"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Person/{id}/_code":{"get":{"tags":["Person"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Organization/{id}/_code":{"get":{"tags":["Organization"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"industryConcept","in":"query","description":"Gets or sets the concept key which classifies the industry in which the organization operates","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/{id}/_code":{},"/ConceptRelationship/{id}/_code":{"get":{"tags":["ConceptRelationship"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"targetConcept","in":"query","description":"Gets or sets the target concept identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Relationship type","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Procedure/{id}/_code":{"get":{"tags":["Procedure"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"method","in":"query","description":"Gets or sets te method/technique used to perform the procedure","type":"string"},{"name":"approachSite","in":"query","description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string"},{"name":"targetSite","in":"query","description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ApplicationEntity/{id}/_code":{"get":{"tags":["ApplicationEntity"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"securityApplication","in":"query","description":"Gets or sets the security application","type":"string"},{"name":"softwareName","in":"query","description":"Gets or sets the name of the software","type":"string"},{"name":"vendorName","in":"query","description":"Gets or sets the vendoer name of the software","type":"string"},{"name":"versionName","in":"query","description":"Gets or sets the version of the software","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/{id}/_code":{"get":{"tags":["Concept"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},{"name":"statusConcept","in":"query","description":"Gets or sets the status concept key","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of concept relationships","type":"string"},{"name":"conceptClass","in":"query","description":"Gets or sets the class identifier","type":"string"},{"name":"referenceTerm","in":"query","description":"Gets a list of concept reference terms","type":"string"},{"name":"name","in":"query","description":"Gets the concept names","type":"string"},{"name":"conceptSet","in":"query","description":"Concept sets as identifiers for XML purposes only","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the concept","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/StockLedgerEntry/{id}/_code":{"get":{"tags":["StockLedgerEntry"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"sequence","in":"query","description":"Gets or sets the sequence of this entry in the ledger","type":"string"},{"name":"act","in":"query","description":"Gets or sets the act which caused this ledger entry to be created","type":"string"},{"name":"container","in":"query","description":"Gets or sets the container to which this ledger entry applies","type":"string"},{"name":"material","in":"query","description":"Gets or sets the material to which the ledger entry applies","type":"string"},{"name":"reason","in":"query","description":"Gets or sets the reason for the ledger entry","type":"string"},{"name":"startOfLine","in":"query","description":"Gets or sets the start of line balance (the known balance before the entry was created)","type":"number"},{"name":"quantity","in":"query","description":"Gets or sets the quantity of the current ledger entry","type":"number"},{"name":"createdBy","in":"query","description":"Gets or sets the security principal that was responsible for the cretion of this ledger entry","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the time that this ledger entry was created","type":"string"},{"name":"timestamp","in":"query","description":"Gets or sets the timestamp when the ledger entry applies to","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the modification date of this object entry","type":"string"},{"name":"type","in":"query","description":"Gets or sets the stock ledger entry type","type":"string","enum":["ledger","rollback","purged"]},{"name":"ref","in":"query","description":"If this entry points to another entry, then the pointer to the entry being referenced","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/StockLedgerEntry"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/IdentityDomain/{id}/_code":{"get":{"tags":["IdentityDomain"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the assigning authority","type":"string"},{"name":"domainName","in":"query","description":"Gets or sets the domain name of the assigning authority","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the assigning authority","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the assigning authority","type":"string"},{"name":"url","in":"query","description":"The URL of the assigning authority","type":"string"},{"name":"assigningAuthority","in":"query","description":"Assigning device identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string"},{"name":"identifierClass","in":"query","description":"Gets or sets the identifier classification key","type":"string"},{"name":"validation","in":"query","description":"Gets or sets the validation regex","type":"string"},{"name":"isUnique","in":"query","description":"True if the assigning authority values should be unique","type":"boolean"},{"name":"customValidator","in":"query","description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},{"name":"checkDigitAlgorithm","in":"query","description":"Gets or sets the check digit algorithm","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/IdentityDomain"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/{id}/_code":{"get":{"tags":["Act"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/{id}/_code":{"get":{"tags":["PlaceService"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"serviceConcept","in":"query","description":"Gets or sets the service concept key","type":"string"},{"name":"serviceSchedule","in":"query","description":"The schedule that the service is offered","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PlaceService"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/{id}/_code":{"get":{"tags":["Entity"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DateObservation/{id}/_code":{"get":{"tags":["DateObservation"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"valuePrecision","in":"query","description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePathwayDefinition/{id}/_code":{"get":{"tags":["CarePathwayDefinition"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the care pathway","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the care pathway","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the care pathway","type":"string"},{"name":"eligibility","in":"query","description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},{"name":"enrollment","in":"query","description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},{"name":"encounterTemplate","in":"query","description":"Gets or sets the type of encounter","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptClass/{id}/_code":{"get":{"tags":["ConceptClass"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the concept class","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptClass"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityExtension/{id}/_code":{"get":{"tags":["EntityExtension"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/{id}/_code":{"get":{"tags":["EntityRelationship"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"holder","in":"query","description":"The entity that this relationship targets","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"strength","in":"query","description":"The strength (confidence) of the relationship between source and target","type":"string"},{"name":"quantity","in":"query","description":"Represents the quantity of target in source","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"relationshipRole","in":"query","description":"Association type key","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Protocol/{id}/_code":{"get":{"tags":["Protocol"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the protocol","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the OID","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Protocol"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptReferenceTerm/{id}/_code":{"get":{"tags":["ConceptReferenceTerm"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"term","in":"query","description":"Gets or sets the reference term identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Gets or sets the relationship type identifier","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationshipType/{id}/_code":{"get":{"tags":["ConceptRelationshipType"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the relationship","type":"string"},{"name":"mnemonic","in":"query","description":"The invariant of the relationship type","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationshipType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodedObservation/{id}/_code":{"get":{"tags":["CodedObservation"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptSet/{id}/_code":{"get":{"tags":["ConceptSet"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptSet"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/{id}/_code":{"get":{"tags":["Material"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailboxMailMessage/{id}/_code":{"get":{"tags":["MailboxMailMessage"],"summary":"Gets the specified barcode for the resource","description":"This method returns a barcode which explicitly points at the specified resource in the specified authority.\r\n            \r\n             The barcode is generated using the server's configuration, and is signed by the server's signing key.\r\n            \r\n             For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/{id}/_code":{"get":{"tags":["Provider"],"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","produces":["image/png"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated","type":"string"},{"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","type":"string","required":false},{"name":"providerSpecialty","in":"query","description":"Gets or sets the provider specialty key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/{id}/_ptr":{"get":{"tags":["CodeSystem"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the code system","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the Oid of the code system","type":"string"},{"name":"authority","in":"query","description":"Gets or sets the authority of the code system","type":"string"},{"name":"url","in":"query","description":"Gets or sets the URL of the code system","type":"string"},{"name":"version","in":"query","description":"Gets or sets the version text of the code system","type":"string"},{"name":"description","in":"query","description":"Gets or sets the human description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodeSystem"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/QuantityObservation/{id}/_ptr":{"get":{"tags":["QuantityObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"value","in":"query","description":"Gets or sets the observed quantity","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"unitOfMeasure","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/QuantityObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ActRelationship/{id}/_ptr":{"get":{"tags":["ActRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"sequence","in":"query","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ActRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Observation/{id}/_ptr":{"get":{"tags":["Observation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Observation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/{id}/_ptr":{"get":{"tags":["PatientEncounter"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"dischargeDisposition","in":"query","description":"Gets or sets the key of discharge disposition","type":"string"},{"name":"admissionSource","in":"query","description":"Gets or sets the admission source type","type":"string"},{"name":"specialArrangement","in":"query","description":"A list of special arrangements which are to be made to the patient during the encounter","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PatientEncounter"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Patient"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ReferenceTerm/{id}/_ptr":{"get":{"tags":["ReferenceTerm"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the reference term","type":"string"},{"name":"codeSystem","in":"query","description":"Gets or sets the code system identifier","type":"string"},{"name":"name","in":"query","description":"Gets display names associated with the reference term","type":"string"},{"name":"concept","in":"query","description":"Gets or sets the concepts related to this data","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/{id}/_ptr":{"get":{"tags":["ExtensionType"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"handlerClass","in":"query","description":"Gets or sets the description","type":"string"},{"name":"uri","in":"query","description":"Gets or sets the uri of the extension","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the extension","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ExtensionType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/{id}/_ptr":{"get":{"tags":["Container"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"capacityQuantity","in":"query","description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"string"},{"name":"diameterQuantity","in":"query","description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"string"},{"name":"heightQuantity","in":"query","description":"Gets or sets the height quantity. The height of the container.","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Container"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/{id}/_ptr":{"get":{"tags":["DeviceEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"manufacturerModelName","in":"query","description":"Gets or sets the manufacturer model name","type":"string"},{"name":"operatingSystemName","in":"query","description":"Gets or sets the operating system name","type":"string"},{"name":"securityDevice","in":"query","description":"Gets or sets the security device key","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DeviceEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/{id}/_ptr":{"get":{"tags":["UserEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"securityUser","in":"query","description":"Gets or sets the security user key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/UserEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TextObservation/{id}/_ptr":{"get":{"tags":["TextObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the textual value","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TextObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Place/{id}/_ptr":{"get":{"tags":["Place"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"isMobile","in":"query","description":"True if location is mobile","type":"boolean"},{"name":"service","in":"query","description":"Gets the services","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Place"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailMessage/{id}/_ptr":{"get":{"tags":["MailMessage"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"body","in":"query","description":"Gets or sets the alert body of the alert.","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the status of the alert.","type":"string","enum":[]},{"name":"from","in":"query","description":"Gets or sets the \"from\" subject if it is a human based message of the alert.","type":"string"},{"name":"fromInfo","in":"query","description":"From Information (string representation)","type":"string"},{"name":"toInfo","in":"query","description":"To information","type":"string"},{"name":"to","in":"query","description":"Legacy property for the \"to\" field (so sync can occur on older tablets)","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets or sets the time this was modified on","type":"string"},{"name":"rcpt","in":"query","description":"The recipient users used for query","type":"string"},{"name":"subject","in":"query","description":"Gets or sets the subject of the alert.","type":"string"},{"name":"mailbox","in":"query","description":"Gets the messages for this mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TemplateDefinition/{id}/_ptr":{"get":{"tags":["TemplateDefinition"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"name","in":"query","description":"Gets or set the name","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/TemplateDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/{id}/_ptr":{"get":{"tags":["ManufacturedMaterial"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"lotNumber","in":"query","description":"Gets or sets the lot number of the manufactured material","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ManufacturedMaterial"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Narrative/{id}/_ptr":{"get":{"tags":["Narrative"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"versionCode","in":"query","description":"The external version number of the structured document","type":"string"},{"name":"language","in":"query","description":"The language in which the document content is written","type":"string"},{"name":"mime","in":"query","description":"Gets or sets the mime type of the narrative content","type":"string"},{"name":"title","in":"query","description":"The title of the clinical document","type":"string"},{"name":"text","in":"query","description":"Gets or sets the text of the document","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Narrative"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DeviceMailbox/{id}/_ptr":{"get":{"tags":["DeviceMailbox"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1"]}],"deprecated":false}},"/SubstanceAdministration/{id}/_ptr":{"get":{"tags":["SubstanceAdministration"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"route","in":"query","description":"Gets or sets the key for route","type":"string"},{"name":"doseUnit","in":"query","description":"Gets or sets the key for dosing unit","type":"string"},{"name":"doseQuantity","in":"query","description":"Gets or sets the amount of substance administered","type":"number"},{"name":"doseSequence","in":"query","description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"string"},{"name":"site","in":"query","description":"Gets or sets the site","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SubstanceAdministration"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePlan/{id}/_ptr":{"get":{"tags":["CarePlan"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"title","in":"query","description":"Gets or sets a human title for the care plan","type":"string"},{"name":"pathway","in":"query","description":"Identifies the care pathway identifier which this care plan is generated for","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePlan"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/{id}/_ptr":{"get":{"tags":["Mailbox"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Mailbox"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/{id}/_ptr":{"get":{"tags":["ConceptExtension"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Person/{id}/_ptr":{"get":{"tags":["Person"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Person"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Organization/{id}/_ptr":{"get":{"tags":["Organization"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"industryConcept","in":"query","description":"Gets or sets the concept key which classifies the industry in which the organization operates","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/{id}/_ptr":{},"/ConceptRelationship/{id}/_ptr":{"get":{"tags":["ConceptRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"targetConcept","in":"query","description":"Gets or sets the target concept identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Relationship type","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Procedure/{id}/_ptr":{"get":{"tags":["Procedure"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"method","in":"query","description":"Gets or sets te method/technique used to perform the procedure","type":"string"},{"name":"approachSite","in":"query","description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string"},{"name":"targetSite","in":"query","description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Procedure"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ApplicationEntity/{id}/_ptr":{"get":{"tags":["ApplicationEntity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"securityApplication","in":"query","description":"Gets or sets the security application","type":"string"},{"name":"softwareName","in":"query","description":"Gets or sets the name of the software","type":"string"},{"name":"vendorName","in":"query","description":"Gets or sets the vendoer name of the software","type":"string"},{"name":"versionName","in":"query","description":"Gets or sets the version of the software","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ApplicationEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/{id}/_ptr":{"get":{"tags":["Concept"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},{"name":"statusConcept","in":"query","description":"Gets or sets the status concept key","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of concept relationships","type":"string"},{"name":"conceptClass","in":"query","description":"Gets or sets the class identifier","type":"string"},{"name":"referenceTerm","in":"query","description":"Gets a list of concept reference terms","type":"string"},{"name":"name","in":"query","description":"Gets the concept names","type":"string"},{"name":"conceptSet","in":"query","description":"Concept sets as identifiers for XML purposes only","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the concept","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/StockLedgerEntry/{id}/_ptr":{"get":{"tags":["StockLedgerEntry"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"sequence","in":"query","description":"Gets or sets the sequence of this entry in the ledger","type":"string"},{"name":"act","in":"query","description":"Gets or sets the act which caused this ledger entry to be created","type":"string"},{"name":"container","in":"query","description":"Gets or sets the container to which this ledger entry applies","type":"string"},{"name":"material","in":"query","description":"Gets or sets the material to which the ledger entry applies","type":"string"},{"name":"reason","in":"query","description":"Gets or sets the reason for the ledger entry","type":"string"},{"name":"startOfLine","in":"query","description":"Gets or sets the start of line balance (the known balance before the entry was created)","type":"number"},{"name":"quantity","in":"query","description":"Gets or sets the quantity of the current ledger entry","type":"number"},{"name":"createdBy","in":"query","description":"Gets or sets the security principal that was responsible for the cretion of this ledger entry","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the time that this ledger entry was created","type":"string"},{"name":"timestamp","in":"query","description":"Gets or sets the timestamp when the ledger entry applies to","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the modification date of this object entry","type":"string"},{"name":"type","in":"query","description":"Gets or sets the stock ledger entry type","type":"string","enum":["ledger","rollback","purged"]},{"name":"ref","in":"query","description":"If this entry points to another entry, then the pointer to the entry being referenced","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/StockLedgerEntry"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/IdentityDomain/{id}/_ptr":{"get":{"tags":["IdentityDomain"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the assigning authority","type":"string"},{"name":"domainName","in":"query","description":"Gets or sets the domain name of the assigning authority","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the assigning authority","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the assigning authority","type":"string"},{"name":"url","in":"query","description":"The URL of the assigning authority","type":"string"},{"name":"assigningAuthority","in":"query","description":"Assigning device identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string"},{"name":"identifierClass","in":"query","description":"Gets or sets the identifier classification key","type":"string"},{"name":"validation","in":"query","description":"Gets or sets the validation regex","type":"string"},{"name":"isUnique","in":"query","description":"True if the assigning authority values should be unique","type":"boolean"},{"name":"customValidator","in":"query","description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},{"name":"checkDigitAlgorithm","in":"query","description":"Gets or sets the check digit algorithm","type":"string"},{"name":"scope","in":"query","description":"Represents scopes to which the authority is bound","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/IdentityDomain"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/{id}/_ptr":{"get":{"tags":["Act"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Act"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/{id}/_ptr":{"get":{"tags":["PlaceService"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"serviceConcept","in":"query","description":"Gets or sets the service concept key","type":"string"},{"name":"serviceSchedule","in":"query","description":"The schedule that the service is offered","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/PlaceService"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/{id}/_ptr":{"get":{"tags":["Entity"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Entity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DateObservation/{id}/_ptr":{"get":{"tags":["DateObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"valuePrecision","in":"query","description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/DateObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePathwayDefinition/{id}/_ptr":{"get":{"tags":["CarePathwayDefinition"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the care pathway","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the care pathway","type":"string"},{"name":"description","in":"query","description":"Gets or sets the description of the care pathway","type":"string"},{"name":"eligibility","in":"query","description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},{"name":"enrollment","in":"query","description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},{"name":"encounterTemplate","in":"query","description":"Gets or sets the type of encounter","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptClass/{id}/_ptr":{"get":{"tags":["ConceptClass"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the concept class","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptClass"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityExtension/{id}/_ptr":{"get":{"tags":["EntityExtension"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"value","in":"query","description":"Gets or sets the value of the extension","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"$object","in":"query","description":"Gets or sets the ignore value","type":"string"},{"name":"display","in":"query","description":"Gets or sets an extension displayable value","type":"string"},{"name":"extensionType","in":"query","description":"Gets or sets the extension type key","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityExtension"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/{id}/_ptr":{"get":{"tags":["EntityRelationship"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"holder","in":"query","description":"The entity that this relationship targets","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"strength","in":"query","description":"The strength (confidence) of the relationship between source and target","type":"string"},{"name":"quantity","in":"query","description":"Represents the quantity of target in source","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"relationshipRole","in":"query","description":"Association type key","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/EntityRelationship"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Protocol/{id}/_ptr":{"get":{"tags":["Protocol"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the protocol","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the OID","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Protocol"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptReferenceTerm/{id}/_ptr":{"get":{"tags":["ConceptReferenceTerm"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"term","in":"query","description":"Gets or sets the reference term identifier","type":"string"},{"name":"relationshipType","in":"query","description":"Gets or sets the relationship type identifier","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptReferenceTerm"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationshipType/{id}/_ptr":{"get":{"tags":["ConceptRelationshipType"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the relationship","type":"string"},{"name":"mnemonic","in":"query","description":"The invariant of the relationship type","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptRelationshipType"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodedObservation/{id}/_ptr":{"get":{"tags":["CodedObservation"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"valueType","in":"query","description":"Value type","type":"string"},{"name":"value","in":"query","description":"Gets or sets the key of the uom concept","type":"string"},{"name":"interpretationConcept","in":"query","description":"Gets or sets the interpretation concept","type":"string"},{"name":"isNegated","in":"query","description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},{"name":"template","in":"query","description":"The template on which the act is based","type":"string"},{"name":"actTime","in":"query","description":"The moment in time that this act occurred in ISO format","type":"string"},{"name":"startTime","in":"query","description":"The time when the act should or did start ocurring in ISO format","type":"string"},{"name":"stopTime","in":"query","description":"The time when the act should or did stop ocurring in ISO format","type":"string"},{"name":"classConcept","in":"query","description":"The classification key of the activity","type":"string"},{"name":"moodConcept","in":"query","description":"The mood (or mode) of the Act instance","type":"string"},{"name":"reasonConcept","in":"query","description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string"},{"name":"obsoletionReason","in":"query","description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string"},{"name":"statusConcept","in":"query","description":"The concept which describes the current status of the act","type":"string"},{"name":"typeConcept","in":"query","description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string"},{"name":"identifier","in":"query","description":"Identifiers by which this act is known","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated acts for this act","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the act","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the act","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the act","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the act","type":"string"},{"name":"protocol","in":"query","description":"Identifies protocols attached to the act","type":"string"},{"name":"participation","in":"query","description":"Gets or sets the entities and participations they play in the act","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo-tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CodedObservation"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptSet/{id}/_ptr":{"get":{"tags":["ConceptSet"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/ConceptSet"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/{id}/_ptr":{"get":{"tags":["Material"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"expiryDate","in":"query","description":"Gets or sets the expiry date of the material","type":"string"},{"name":"formConcept","in":"query","description":"Gets or sets the form concept's key","type":"string"},{"name":"isAdministrable","in":"query","description":"True if the material is simply administrative","type":"boolean"},{"name":"quantity","in":"query","description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"string"},{"name":"quantityConcept","in":"query","description":"Gets or sets the quantity concept ref","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Material"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailboxMailMessage/{id}/_ptr":{"get":{"tags":["MailboxMailMessage"],"summary":"Gets the digitally signed pointer (in JWS format) for the resource","description":"This operation (like the _code operation) generates a digitally signed pointer for an object. Rather than rendering that pointer as a visual code, the API will return\r\n             the structured contents of that code so the client can best determine how to represent the data.\r\n            \r\n             For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"message","in":"query","description":"Gets the target of the association","type":"string"},{"name":"flags","in":"query","description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},{"name":"time","in":"query","description":"Gets or sets the time of the alert.","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/{id}/_ptr":{"get":{"tags":["Provider"],"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created","type":"string"},{"name":"providerSpecialty","in":"query","description":"Gets or sets the provider specialty key","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Provider"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/_ptr":{"search":{"tags":[],"summary":"Resolve a code to a resource by posting a form-encoded search to the API","description":"This operation will decode and validate the pointer passed in the","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"name":"body","in":"body","description":"The search parameters in in HTTP form query","schema":{"$ref":"#/definitions/NameValueCollection"}}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[],"deprecated":false}},"/Patient/{id}/carepaths/{childResourceKey}":{"get":{"tags":["Patient"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the hosting (container object)","type":"string"},{"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should include related objects in a bundle to the caller","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the container","type":"string"},{"name":"childResourceKey","in":"path","description":"The actual value of the sub-key","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the container","type":"string"},{"name":"childResourceKey","in":"path","description":"The actual value of the sub-key","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/match-candidate/{childResourceKey}":{"get":{"tags":["Patient"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the hosting (container object)","type":"string"},{"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should include related objects in a bundle to the caller","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the container","type":"string"},{"name":"childResourceKey","in":"path","description":"The actual value of the sub-key","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Mailbox/{id}/MailMessage/{childResourceKey}":{"get":{"tags":["Mailbox"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the hosting (container object)","type":"string"},{"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should include related objects in a bundle to the caller","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["Mailbox"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the container","type":"string"},{"name":"childResourceKey","in":"path","description":"The actual value of the sub-key","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/{id}/Concept/{childResourceKey}":{},"/ConceptSet/{id}/_members/{childResourceKey}":{"get":{"tags":["ConceptSet"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the hosting (container object)","type":"string"},{"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should include related objects in a bundle to the caller","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the hosting (container object)","type":"string"},{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identiifer of the container","type":"string"},{"name":"body","in":"body","description":"The object to be added to the collection","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/CarePathwayDefinition"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/{id}/match-ignore":{},"/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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the hosting (container object)","type":"string"},{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"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","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The identiifer of the container","type":"string"},{"name":"body","in":"body","description":"The object to be added to the collection","schema":{"$ref":"#/definitions/Bundle"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Mailbox/{id}/MailMessage":{"get":{"tags":["Mailbox"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the hosting (container object)","type":"string"},{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/MailboxMailMessage"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/{id}/Concept":{},"/ConceptSet/{id}/_members":{"get":{"tags":["ConceptSet"],"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)","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"The key of the hosting (container object)","type":"string"},{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/$xsd-complete":{"post":{"tags":["CodeSystem"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/$schema-complete":{"post":{"tags":["CodeSystem"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/$deletedObjects":{"post":{"tags":["CodeSystem"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/$validate":{"post":{"tags":["CodeSystem"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CodeSystem/$xref-use":{"post":{"tags":["CodeSystem"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/QuantityObservation/$xsd-complete":{"post":{"tags":["QuantityObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/QuantityObservation/$expand":{"post":{"tags":["QuantityObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/QuantityObservation/$schema-complete":{"post":{"tags":["QuantityObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/QuantityObservation/$validate":{"post":{"tags":["QuantityObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/QuantityObservation/$xref-use":{"post":{"tags":["QuantityObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ActRelationship/$xsd-complete":{"post":{"tags":["ActRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ActRelationship/$schema-complete":{"post":{"tags":["ActRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ActRelationship/$validate":{"post":{"tags":["ActRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ActRelationship/$xref-use":{"post":{"tags":["ActRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Observation/$xsd-complete":{"post":{"tags":["Observation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Observation/$schema-complete":{"post":{"tags":["Observation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Observation/$validate":{"post":{"tags":["Observation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Observation/$xref-use":{"post":{"tags":["Observation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/$xsd-complete":{"post":{"tags":["PatientEncounter"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/$expand":{"post":{"tags":["PatientEncounter"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/$schema-complete":{"post":{"tags":["PatientEncounter"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/$validate":{"post":{"tags":["PatientEncounter"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/PatientEncounter/$xref-use":{"post":{"tags":["PatientEncounter"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/$analyze":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/$xsd-complete":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/$match":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/$expand":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/$schema-complete":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/$generate-careplan":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/$validate":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/$match-reset":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Patient/$xref-use":{"post":{"tags":["Patient"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ReferenceTerm/$xsd-complete":{"post":{"tags":["ReferenceTerm"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ReferenceTerm/$schema-complete":{"post":{"tags":["ReferenceTerm"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ReferenceTerm/$deletedObjects":{"post":{"tags":["ReferenceTerm"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ReferenceTerm/$validate":{"post":{"tags":["ReferenceTerm"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ReferenceTerm/$xref-use":{"post":{"tags":["ReferenceTerm"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/$xsd-complete":{"post":{"tags":["ExtensionType"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/$schema-complete":{"post":{"tags":["ExtensionType"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/$handlers":{"post":{"tags":["ExtensionType"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/$deletedObjects":{"post":{"tags":["ExtensionType"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/$validate":{"post":{"tags":["ExtensionType"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ExtensionType/$xref-use":{"post":{"tags":["ExtensionType"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/$xsd-complete":{"post":{"tags":["Container"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/$schema-complete":{"post":{"tags":["Container"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/$validate":{"post":{"tags":["Container"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Container/$xref-use":{"post":{"tags":["Container"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/$xsd-complete":{"post":{"tags":["DeviceEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/$schema-complete":{"post":{"tags":["DeviceEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/$validate":{"post":{"tags":["DeviceEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DeviceEntity/$xref-use":{"post":{"tags":["DeviceEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/$xsd-complete":{"post":{"tags":["UserEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/$schema-complete":{"post":{"tags":["UserEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/$validate":{"post":{"tags":["UserEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/UserEntity/$xref-use":{"post":{"tags":["UserEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TextObservation/$xsd-complete":{"post":{"tags":["TextObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/TextObservation/$expand":{"post":{"tags":["TextObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/TextObservation/$schema-complete":{"post":{"tags":["TextObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/TextObservation/$validate":{"post":{"tags":["TextObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/TextObservation/$xref-use":{"post":{"tags":["TextObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Place/$xsd-complete":{"post":{"tags":["Place"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Place/$expand":{"post":{"tags":["Place"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Place/$schema-complete":{"post":{"tags":["Place"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Place/$validate":{"post":{"tags":["Place"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Place/$xref-use":{"post":{"tags":["Place"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailMessage/$xsd-complete":{"post":{"tags":["MailMessage"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailMessage/$schema-complete":{"post":{"tags":["MailMessage"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailMessage/$xref-use":{"post":{"tags":["MailMessage"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/TemplateDefinition/$xsd-complete":{},"/TemplateDefinition/$schema-complete":{},"/TemplateDefinition/$deletedObjects":{},"/TemplateDefinition/$validate":{},"/TemplateDefinition/$xref-use":{},"/ManufacturedMaterial/$xsd-complete":{"post":{"tags":["ManufacturedMaterial"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/$expand":{"post":{"tags":["ManufacturedMaterial"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/$schema-complete":{"post":{"tags":["ManufacturedMaterial"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/$validate":{"post":{"tags":["ManufacturedMaterial"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ManufacturedMaterial/$xref-use":{"post":{"tags":["ManufacturedMaterial"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Narrative/$xsd-complete":{"post":{"tags":["Narrative"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Narrative/$expand":{"post":{"tags":["Narrative"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Narrative/$schema-complete":{"post":{"tags":["Narrative"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Narrative/$validate":{"post":{"tags":["Narrative"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Narrative/$xref-use":{"post":{"tags":["Narrative"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DeviceMailbox/${operationName}":{},"/SubstanceAdministration/$xsd-complete":{"post":{"tags":["SubstanceAdministration"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/SubstanceAdministration/$expand":{"post":{"tags":["SubstanceAdministration"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/SubstanceAdministration/$schema-complete":{"post":{"tags":["SubstanceAdministration"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/SubstanceAdministration/$validate":{"post":{"tags":["SubstanceAdministration"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/SubstanceAdministration/$xref-use":{"post":{"tags":["SubstanceAdministration"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePlan/$xsd-complete":{"post":{"tags":["CarePlan"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CarePlan/$schema-complete":{"post":{"tags":["CarePlan"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CarePlan/$validate":{"post":{"tags":["CarePlan"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CarePlan/$xref-use":{"post":{"tags":["CarePlan"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/$xsd-complete":{"post":{"tags":["Mailbox"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/$schema-complete":{"post":{"tags":["Mailbox"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/$send-mail":{"post":{"tags":["Mailbox"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Mailbox/$xref-use":{"post":{"tags":["Mailbox"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/$xsd-complete":{"post":{"tags":["ConceptExtension"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/$schema-complete":{"post":{"tags":["ConceptExtension"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/$validate":{"post":{"tags":["ConceptExtension"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptExtension/$xref-use":{"post":{"tags":["ConceptExtension"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Person/$xsd-complete":{"post":{"tags":["Person"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Person/$expand":{"post":{"tags":["Person"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Person/$schema-complete":{"post":{"tags":["Person"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Person/$validate":{"post":{"tags":["Person"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Person/$xref-use":{"post":{"tags":["Person"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Organization/$xsd-complete":{"post":{"tags":["Organization"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Organization/$expand":{"post":{"tags":["Organization"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Organization/$schema-complete":{"post":{"tags":["Organization"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Organization/$validate":{"post":{"tags":["Organization"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Organization/$xref-use":{"post":{"tags":["Organization"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/$analyze":{"post":{"tags":["Bundle"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/$xsd-complete":{"post":{"tags":["Bundle"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/$schema-complete":{"post":{"tags":["Bundle"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/$validate":{"post":{"tags":["Bundle"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Bundle/$xref-use":{"post":{"tags":["Bundle"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationship/$xsd-complete":{"post":{"tags":["ConceptRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationship/$schema-complete":{"post":{"tags":["ConceptRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationship/$validate":{"post":{"tags":["ConceptRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationship/$xref-use":{"post":{"tags":["ConceptRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Procedure/$xsd-complete":{"post":{"tags":["Procedure"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Procedure/$expand":{"post":{"tags":["Procedure"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Procedure/$schema-complete":{"post":{"tags":["Procedure"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Procedure/$validate":{"post":{"tags":["Procedure"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Procedure/$xref-use":{"post":{"tags":["Procedure"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ApplicationEntity/$xsd-complete":{"post":{"tags":["ApplicationEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ApplicationEntity/$schema-complete":{"post":{"tags":["ApplicationEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ApplicationEntity/$validate":{"post":{"tags":["ApplicationEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ApplicationEntity/$xref-use":{"post":{"tags":["ApplicationEntity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/$xsd-complete":{"post":{"tags":["Concept"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/$schema-complete":{"post":{"tags":["Concept"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/$deletedObjects":{"post":{"tags":["Concept"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/$validate":{"post":{"tags":["Concept"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Concept/$xref-use":{"post":{"tags":["Concept"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/StockLedgerEntry/$xsd-complete":{"post":{"tags":["StockLedgerEntry"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/StockLedgerEntry/$schema-complete":{"post":{"tags":["StockLedgerEntry"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/StockLedgerEntry/$xref-use":{"post":{"tags":["StockLedgerEntry"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/IdentityDomain/$xsd-complete":{},"/IdentityDomain/$schema-complete":{},"/IdentityDomain/$deletedObjects":{},"/IdentityDomain/$validate":{},"/IdentityDomain/$xref-use":{},"/Act/$analyze":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/$xsd-complete":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/$expand":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/$schema-complete":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/$deletedObjects":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/$validate":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/$emr-change-rct":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Act/$xref-use":{"post":{"tags":["Act"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/$xsd-complete":{"post":{"tags":["PlaceService"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/$schema-complete":{"post":{"tags":["PlaceService"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/$validate":{"post":{"tags":["PlaceService"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/PlaceService/$xref-use":{"post":{"tags":["PlaceService"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/$xsd-complete":{"post":{"tags":["Entity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/$expand":{"post":{"tags":["Entity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/$schema-complete":{"post":{"tags":["Entity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/$deletedObjects":{"post":{"tags":["Entity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/$validate":{"post":{"tags":["Entity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Entity/$xref-use":{"post":{"tags":["Entity"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/DateObservation/$xsd-complete":{"post":{"tags":["DateObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DateObservation/$schema-complete":{"post":{"tags":["DateObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DateObservation/$validate":{"post":{"tags":["DateObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/DateObservation/$xref-use":{"post":{"tags":["DateObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CarePathwayDefinition/$xsd-complete":{"post":{"tags":["CarePathwayDefinition"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CarePathwayDefinition/$schema-complete":{"post":{"tags":["CarePathwayDefinition"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CarePathwayDefinition/$validate":{"post":{"tags":["CarePathwayDefinition"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/CarePathwayDefinition/$xref-use":{"post":{"tags":["CarePathwayDefinition"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptClass/$xsd-complete":{},"/ConceptClass/$schema-complete":{},"/ConceptClass/$deletedObjects":{},"/ConceptClass/$validate":{},"/ConceptClass/$xref-use":{},"/EntityExtension/$xsd-complete":{"post":{"tags":["EntityExtension"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityExtension/$schema-complete":{"post":{"tags":["EntityExtension"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityExtension/$validate":{"post":{"tags":["EntityExtension"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityExtension/$xref-use":{"post":{"tags":["EntityExtension"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/$xsd-complete":{"post":{"tags":["EntityRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/$schema-complete":{"post":{"tags":["EntityRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/$validate":{"post":{"tags":["EntityRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/EntityRelationship/$xref-use":{"post":{"tags":["EntityRelationship"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Protocol/$xsd-complete":{"post":{"tags":["Protocol"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Protocol/$schema-complete":{"post":{"tags":["Protocol"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Protocol/$validate":{"post":{"tags":["Protocol"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Protocol/$xref-use":{"post":{"tags":["Protocol"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptReferenceTerm/$xsd-complete":{"post":{"tags":["ConceptReferenceTerm"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptReferenceTerm/$schema-complete":{"post":{"tags":["ConceptReferenceTerm"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptReferenceTerm/$validate":{"post":{"tags":["ConceptReferenceTerm"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptReferenceTerm/$xref-use":{"post":{"tags":["ConceptReferenceTerm"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptRelationshipType/$xsd-complete":{},"/ConceptRelationshipType/$schema-complete":{},"/ConceptRelationshipType/$validate":{},"/ConceptRelationshipType/$xref-use":{},"/CodedObservation/$xsd-complete":{"post":{"tags":["CodedObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CodedObservation/$expand":{"post":{"tags":["CodedObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CodedObservation/$schema-complete":{"post":{"tags":["CodedObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CodedObservation/$validate":{"post":{"tags":["CodedObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/CodedObservation/$xref-use":{"post":{"tags":["CodedObservation"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/ConceptSet/$xsd-complete":{"post":{"tags":["ConceptSet"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/$expand":{"post":{"tags":["ConceptSet"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/$schema-complete":{"post":{"tags":["ConceptSet"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/$deletedObjects":{"post":{"tags":["ConceptSet"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/$validate":{"post":{"tags":["ConceptSet"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/$xref-use":{"post":{"tags":["ConceptSet"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.7","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/$xsd-complete":{"post":{"tags":["Material"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/$expand":{"post":{"tags":["Material"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/$schema-complete":{"post":{"tags":["Material"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/$validate":{"post":{"tags":["Material"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Material/$xref-use":{"post":{"tags":["Material"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailboxMailMessage/$xsd-complete":{"post":{"tags":["MailboxMailMessage"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailboxMailMessage/$schema-complete":{"post":{"tags":["MailboxMailMessage"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/MailboxMailMessage/$xref-use":{"post":{"tags":["MailboxMailMessage"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/$xsd-complete":{"post":{"tags":["Provider"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/$schema-complete":{"post":{"tags":["Provider"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/$validate":{"post":{"tags":["Provider"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Provider/$xref-use":{"post":{"tags":["Provider"],"summary":"Invokes the specified operation","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"parameters","in":"body","description":"The parameters to invoke the operation with","schema":{"$ref":"#/definitions/ParameterCollection"}},{"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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ActRelationship/_relationshipRule":{"get":{"tags":["ActRelationship"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"sequence","in":"query","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/RelationshipValidationRule"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Patient/match-candidate":{"get":{"tags":["Patient"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Mailbox/_recipientDirectory":{"get":{"tags":["Mailbox"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SecurityEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/IdentityDomain/_validator":{},"/IdentityDomain/_checkDigit":{},"/EntityRelationship/_relationshipRule":{"get":{"tags":["EntityRelationship"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"holder","in":"query","description":"The entity that this relationship targets","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"strength","in":"query","description":"The strength (confidence) of the relationship between source and target","type":"string"},{"name":"quantity","in":"query","description":"Represents the quantity of target in source","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"relationshipRole","in":"query","description":"Association type key","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/RelationshipValidationRule"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/_members":{"get":{"tags":["ConceptSet"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"_offset","in":"query","description":"The offet of the first result to return","type":"number","required":false},{"name":"_count","in":"query","description":"The count of items to return in this result set","type":"number","required":false},{"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","type":"boolean","required":false},{"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","type":"string","required":false},{"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","type":"string","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ActRelationship/_relationshipRule/{childResourceKey}":{"get":{"tags":["ActRelationship"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should include related objects","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"sequence","in":"query","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/RelationshipValidationRule"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["ActRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"childResourceKey","in":"path","description":"The actual value of the sub-key","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/RelationshipValidationRule"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/Patient/match-candidate/{childResourceKey}":{"get":{"tags":["Patient"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should include related objects","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient","type":"string"},{"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement","type":"string"},{"name":"religion","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes","type":"string"},{"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level","type":"string"},{"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key","type":"string"},{"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML","type":"string"},{"name":"language","in":"query","description":"Gets the person's languages of communication","type":"string"},{"name":"occupation","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept","type":"string"},{"name":"deceasedDate","in":"query","description":"Deceased date XML","type":"string"},{"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},{"name":"vipStatus","in":"query","description":"Gets or sets the VIP code","type":"string"},{"name":"nationality","in":"query","description":"Gets or sets the religious affiliation","type":"string"},{"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity","type":"string"},{"name":"classConcept","in":"query","description":"Class concept","type":"string"},{"name":"creationAct","in":"query","description":"Creation act reference","type":"string"},{"name":"determinerConcept","in":"query","description":"Determiner concept","type":"string"},{"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity","type":"string"},{"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity","type":"string"},{"name":"name","in":"query","description":"Gets a list of all names associated with the entity","type":"string"},{"name":"note","in":"query","description":"Gets a list of all notes associated with the entity","type":"string"},{"name":"participation","in":"query","description":"Gets the acts in which this entity participates","type":"string"},{"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity","type":"string"},{"name":"statusConcept","in":"query","description":"Status concept id","type":"string"},{"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity","type":"string"},{"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity","type":"string"},{"name":"template","in":"query","description":"Gets the template key","type":"string"},{"name":"typeConcept","in":"query","description":"Type concept identifier","type":"string"},{"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity","type":"string"},{"name":"geo","in":"query","description":"Gets or sets the geo tag","type":"string"},{"name":"etag","in":"query","description":"Override the ETag","type":"string"},{"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record","type":"string"},{"name":"head","in":"query","description":"True if the object is the head version","type":"boolean"},{"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object","type":"string"},{"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false},"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"childResourceKey","in":"path","description":"The actual value of the sub-key","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Bundle"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"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"]}],"deprecated":false}},"/Mailbox/_recipientDirectory/{childResourceKey}":{"get":{"tags":["Mailbox"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should include related objects","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"owner","in":"query","description":"Gets or sets the user which owns this mailbox","type":"string"},{"name":"name","in":"query","description":"Gets or sets the name of the mailbox","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/SecurityEntity"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/IdentityDomain/_validator/{childResourceKey}":{},"/IdentityDomain/_checkDigit/{childResourceKey}":{},"/EntityRelationship/_relationshipRule/{childResourceKey}":{"get":{"tags":["EntityRelationship"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should include related objects","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"externId","in":"query","description":"Gets or sets the external key for the object","type":"string"},{"name":"holder","in":"query","description":"The entity that this relationship targets","type":"string"},{"name":"negationInd","in":"query","description":"A negation indicator - used to flag this relationship as negated","type":"string"},{"name":"strength","in":"query","description":"The strength (confidence) of the relationship between source and target","type":"string"},{"name":"quantity","in":"query","description":"Represents the quantity of target in source","type":"string"},{"name":"relationshipType","in":"query","description":"Association type key","type":"string"},{"name":"relationshipRole","in":"query","description":"Association type key","type":"string"},{"name":"classification","in":"query","description":"Association type key","type":"string"},{"name":"target","in":"query","description":"The target of the association","type":"string"},{"name":"effectiveVersionSequence","in":"query","description":"Gets or sets the version sequence of the source object when this assoication became active","type":"string"},{"name":"obsoleteVersionSequence","in":"query","description":"Gets or sets the sequence identifier of the source when this association is no longer active","type":"string"},{"name":"modifiedOn","in":"query","description":"Get the modification date","type":"string"},{"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/RelationshipValidationRule"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false},"delete":{"tags":["EntityRelationship"],"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.","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"childResourceKey","in":"path","description":"The actual value of the sub-key","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","type":"string","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/RelationshipValidationRule"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}},"/ConceptSet/_members/{childResourceKey}":{"get":{"tags":["ConceptSet"],"summary":"Performs a linked or chained search on a sub-property","produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"],"parameters":[{"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch","type":"string"},{"name":"_bundle","in":"query","description":"True if the server should include related objects","type":"boolean","required":false},{"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","type":"string","required":false},{"name":"name","in":"query","description":"Gets or sets the name of the concept set","type":"string"},{"name":"mnemonic","in":"query","description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},{"name":"oid","in":"query","description":"Gets or sets the oid of the concept set","type":"string"},{"name":"url","in":"query","description":"Gets or sets the url of the concept set","type":"string"},{"name":"concept","in":"query","description":"Concepts as identifiers for XML purposes only","type":"string"},{"name":"compose","in":"query","description":"If the concept set is composed of other concept sets","type":"string"},{"name":"updatedTime","in":"query","description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},{"name":"modifiedOn","in":"query","description":"Gets the time this item was modified","type":"string"},{"name":"updatedBy","in":"query","description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string"},{"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format","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","type":"string"},{"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object","type":"string"},{"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string"},{"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object","type":"string"},{"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in","type":"string"},{"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated","type":"string"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","schema":{"$ref":"#/definitions/Concept"}},"400":{"description":"The provided resource was in an incorrect format","schema":{"$ref":"#/definitions/RestServiceFault"}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","schema":{"$ref":"#/definitions/RestServiceFault"}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"404":{"description":"The requested object does not exist","schema":{"$ref":"#/definitions/RestServiceFault"}},"410":{"description":"The specified object did exist however is no-longer present","schema":{"$ref":"#/definitions/RestServiceFault"}},"415":{"description":"The client is submitting an invalid object","schema":{"$ref":"#/definitions/RestServiceFault"}},"422":{"description":"There was a business rule violation executing the operation","schema":{"$ref":"#/definitions/RestServiceFault"}},"429":{"description":"The server rejected the request due to a throttling constraint","schema":{"$ref":"#/definitions/RestServiceFault"}},"500":{"description":"The server encountered an error processing the result","schema":{"$ref":"#/definitions/RestServiceFault"}},"503":{"description":"The service is not available (starting up or shutting down)","schema":{"$ref":"#/definitions/RestServiceFault"}}},"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.4.0","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"deprecated":false}}},"definitions":{"ConceptSet":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the concept set","type":"string"},"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the concept set","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"Gets or sets the url of the concept set","type":"string"},"concept":{"xml":{"name":"concept","attribute":false},"description":"Concepts as identifiers for XML purposes only","type":"array","items":{"type":"string","format":"uuid"}},"compose":{"xml":{"name":"compose","attribute":false},"description":"If the concept set is composed of other concept sets","type":"array","items":{"$ref":"#/definitions/ConceptSetComposition","type":"object"}},"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 set of concepts","type":"object"},"Object":{"properties":{},"type":"object"},"Container":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"lotNumber":{"xml":{"name":"lotNumber","attribute":false},"description":"Gets or sets the lot number of the manufactured material","type":"string"},"capacityQuantity":{"xml":{"name":"capacityQuantity","attribute":false},"description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"number","format":"double"},"diameterQuantity":{"xml":{"name":"diameterQuantity","attribute":false},"description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"number","format":"double"},"heightQuantity":{"xml":{"name":"heightQuantity","attribute":false},"description":"Gets or sets the height quantity. The height of the container.","type":"number","format":"double"},"expiryDate":{"xml":{"name":"expiryDate","attribute":false},"description":"Gets or sets the expiry date of the material","type":"string"},"formConcept":{"xml":{"name":"formConcept","attribute":false},"description":"Gets or sets the form concept's key","type":"string","format":"uuid"},"isAdministrable":{"xml":{"name":"isAdministrable","attribute":false},"description":"True if the material is simply administrative","type":"boolean"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"number","format":"double"},"quantityConcept":{"xml":{"name":"quantityConcept","attribute":false},"description":"Gets or sets the quantity concept ref","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":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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 a container.","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":"#/definitions/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"},"ConceptRelationshipType":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the relationship","type":"string"},"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"The invariant of the relationship type","type":"string"},"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":"Concept relationship type","type":"object"},"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"SecurityEntity":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"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":"Security Entity base class","type":"object"},"ApplicationEntity":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"securityApplication":{"xml":{"name":"securityApplication","attribute":false},"description":"Gets or sets the security application","type":"string","format":"uuid"},"softwareName":{"xml":{"name":"softwareName","attribute":false},"description":"Gets or sets the name of the software","type":"string"},"vendorName":{"xml":{"name":"vendorName","attribute":false},"description":"Gets or sets the vendoer name of the software","type":"string"},"versionName":{"xml":{"name":"versionName","attribute":false},"description":"Gets or sets the version of the software","type":"string"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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 the clinical data object for Applications","type":"object"},"Material":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"expiryDate":{"xml":{"name":"expiryDate","attribute":false},"description":"Gets or sets the expiry date of the material","type":"string"},"formConcept":{"xml":{"name":"formConcept","attribute":false},"description":"Gets or sets the form concept's key","type":"string","format":"uuid"},"isAdministrable":{"xml":{"name":"isAdministrable","attribute":false},"description":"True if the material is simply administrative","type":"boolean"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"number","format":"double"},"quantityConcept":{"xml":{"name":"quantityConcept","attribute":false},"description":"Gets or sets the quantity concept ref","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":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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 a material which describes a type of material (i.e. scapel, antigen, etc.) and serves as a base class for manufactured materials","type":"object"},"XmlSchema":{"properties":{"include":{"xml":{"name":"include","attribute":false},"type":"array","items":{"type":"object"}},"simpleType":{"xml":{"name":"simpleType","attribute":false},"type":"array","items":{"type":"object"}}},"type":"object"},"TemplateDefinition":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic","type":"string"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets or set the name","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the concept set","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description","type":"string"},"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 template definition","type":"object"},"Place":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"isMobile":{"xml":{"name":"isMobile","attribute":false},"description":"True if location is mobile","type":"boolean"},"service":{"xml":{"name":"service","attribute":false},"description":"Gets the services","type":"array","items":{"$ref":"#/definitions/PlaceService","type":"object"}},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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":"An entity which is a place where healthcare services are delivered","type":"object"},"ReferenceTerm":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic for the reference term","type":"string"},"codeSystem":{"xml":{"name":"codeSystem","attribute":false},"description":"Gets or sets the code system identifier","type":"string","format":"uuid"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets display names associated with the reference term","type":"array","items":{"$ref":"#/definitions/ReferenceTermName","type":"object"}},"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 basic reference term","type":"object"},"Narrative":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"versionCode":{"xml":{"name":"versionCode","attribute":false},"description":"The external version number of the structured document","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"The language in which the document content is written","type":"string"},"mime":{"xml":{"name":"mime","attribute":false},"description":"Gets or sets the mime type of the narrative content","type":"string"},"title":{"xml":{"name":"title","attribute":false},"description":"The title of the clinical document","type":"string"},"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the text of the document","type":"array","items":{"type":"number","format":"byte"}},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/definitions/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/definitions/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/definitions/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/definitions/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/definitions/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/definitions/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/definitions/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/definitions/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 a narrative object in the reference model","type":"object"},"RelationshipValidationRule":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the validation rule was modified on","type":"string","format":"date"},"sourceClass":{"xml":{"name":"sourceClass","attribute":false},"description":"Gets the classification key of the source object to which this classification applies","type":"string","format":"uuid"},"targetClass":{"xml":{"name":"targetClass","attribute":false},"description":"Get the target class key","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Gets the relationship type between the","type":"string","format":"uuid"},"appliesTo":{"xml":{"name":"appliesTo","attribute":false},"description":"Gets or sets the application class for XML","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets the description for the validation","type":"string"},"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 relationship validation rule between two","type":"object"},"Provider":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"providerSpecialty":{"xml":{"name":"providerSpecialty","attribute":false},"description":"Gets or sets the provider specialty key","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":"#/definitions/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":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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 a provider role of a person","type":"object"},"Organization":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"industryConcept":{"xml":{"name":"industryConcept","attribute":false},"description":"Gets or sets the concept key which classifies the industry in which the organization operates","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":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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":"Organization entity","type":"object"},"Concept":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Gets or sets the status concept key","type":"string","format":"uuid"},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of concept relationships","type":"array","items":{"$ref":"#/definitions/ConceptRelationship","type":"object"}},"conceptClass":{"xml":{"name":"conceptClass","attribute":false},"description":"Gets or sets the class identifier","type":"string","format":"uuid"},"referenceTerm":{"xml":{"name":"referenceTerm","attribute":false},"description":"Gets a list of concept reference terms","type":"array","items":{"$ref":"#/definitions/ConceptReferenceTerm","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets the concept names","type":"array","items":{"$ref":"#/definitions/ConceptName","type":"object"}},"conceptSet":{"xml":{"name":"conceptSet","attribute":false},"description":"Concept sets as identifiers for XML purposes only","type":"array","items":{"type":"string","format":"uuid"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the concept","type":"array","items":{"$ref":"#/definitions/ConceptTag","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the concept","type":"array","items":{"$ref":"#/definitions/ConceptExtension","type":"object"}},"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":"A class representing a generic concept used in the SanteDB datamodel","type":"object"},"CarePlan":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"title":{"xml":{"name":"title","attribute":false},"description":"Gets or sets a human title for the care plan","type":"string"},"pathway":{"xml":{"name":"pathway","attribute":false},"description":"Identifies the care pathway identifier which this care plan is generated for","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/definitions/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/definitions/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/definitions/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/definitions/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/definitions/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/definitions/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/definitions/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/definitions/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 a care plan","type":"object"},"ConceptExtension":{"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"},"ConceptRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"targetConcept":{"xml":{"name":"targetConcept","attribute":false},"description":"Gets or sets the target concept identifier","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Relationship type","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 relationship between two concepts","type":"object"},"Person":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"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":"#/definitions/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":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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 person","type":"object"},"MailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/messaging"},"properties":{"body":{"xml":{"name":"body","attribute":false},"description":"Gets or sets the alert body of the alert.","type":"string"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the status of the alert.","type":"string","enum":["None","Alert","LowPriority","HighPriority"]},"from":{"xml":{"name":"from","attribute":false},"description":"Gets or sets the \"from\" subject if it is a human based message of the alert.","type":"string","format":"uuid"},"fromInfo":{"xml":{"name":"fromInfo","attribute":false},"description":"From Information (string representation)","type":"string"},"toInfo":{"xml":{"name":"toInfo","attribute":false},"description":"To information","type":"string"},"to":{"xml":{"name":"to","attribute":false},"description":"Legacy property for the \"to\" field (so sync can occur on older tablets)","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets the time this was modified on","type":"string","format":"date"},"rcpt":{"xml":{"name":"rcpt","attribute":false},"description":"The recipient users used for query","type":"array","items":{"type":"string","format":"uuid"}},"subject":{"xml":{"name":"subject","attribute":false},"description":"Gets or sets the subject of the alert.","type":"string"},"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 an alert message.","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"},"Procedure":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"method":{"xml":{"name":"method","attribute":false},"description":"Gets or sets te method/technique used to perform the procedure","type":"string","format":"uuid"},"approachSite":{"xml":{"name":"approachSite","attribute":false},"description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string","format":"uuid"},"targetSite":{"xml":{"name":"targetSite","attribute":false},"description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/definitions/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/definitions/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/definitions/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/definitions/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/definitions/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/definitions/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/definitions/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/definitions/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 a class which has an immediate and primary outcome and is an alteration\r\n            of the physical condition of the subject.","type":"object"},"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":"#/definitions/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"},"Observation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"interpretationConcept":{"xml":{"name":"interpretationConcept","attribute":false},"description":"Gets or sets the interpretation concept","type":"string","format":"uuid"},"valueType":{"xml":{"name":"valueType","attribute":false},"description":"Value type","type":"string"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/definitions/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/definitions/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/definitions/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/definitions/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/definitions/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/definitions/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/definitions/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/definitions/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 a act (","type":"object"},"Act":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/definitions/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/definitions/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/definitions/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/definitions/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/definitions/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/definitions/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/definitions/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/definitions/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 the base class for an act (something which is done or actioned on)","type":"object"},"Protocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the protocol","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the OID","type":"string"},"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 the model of a clinical protocol for CDR","type":"object"},"UserEntity":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"securityUser":{"xml":{"name":"securityUser","attribute":false},"description":"Gets or sets the security user key","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":"#/definitions/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":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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 a user entity","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"},"ExtensionType":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"handlerClass":{"xml":{"name":"handlerClass","attribute":false},"description":"Gets or sets the description","type":"string"},"uri":{"xml":{"name":"uri","attribute":false},"description":"Gets or sets the uri of the extension","type":"string"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the extension","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":"Instructions on how an extensionshould be handled","type":"object"},"ConceptClass":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the concept class","type":"string"},"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic","type":"string"},"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":"Identifies a classification for a concept","type":"object"},"CodeSystem":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the code system","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the Oid of the code system","type":"string"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Gets or sets the authority of the code system","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"Gets or sets the URL of the code system","type":"string"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the version text of the code system","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the human description","type":"string"},"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 code system which is a collection of reference terms","type":"object"},"DateObservation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"valueType":{"xml":{"name":"valueType","attribute":false},"description":"Value type","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the key of the uom concept","type":"string"},"valuePrecision":{"xml":{"name":"valuePrecision","attribute":false},"description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},"interpretationConcept":{"xml":{"name":"interpretationConcept","attribute":false},"description":"Gets or sets the interpretation concept","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/definitions/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/definitions/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/definitions/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/definitions/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/definitions/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/definitions/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/definitions/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/definitions/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 observation which contains a date value","type":"object"},"Mailbox":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"owner":{"xml":{"name":"owner","attribute":false},"description":"Gets or sets the user which owns this mailbox","type":"string","format":"uuid"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the mailbox","type":"string"},"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 mailbox - a particular folder or place which holds","type":"object"},"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"},"ManufacturedMaterial":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"lotNumber":{"xml":{"name":"lotNumber","attribute":false},"description":"Gets or sets the lot number of the manufactured material","type":"string"},"expiryDate":{"xml":{"name":"expiryDate","attribute":false},"description":"Gets or sets the expiry date of the material","type":"string"},"formConcept":{"xml":{"name":"formConcept","attribute":false},"description":"Gets or sets the form concept's key","type":"string","format":"uuid"},"isAdministrable":{"xml":{"name":"isAdministrable","attribute":false},"description":"True if the material is simply administrative","type":"boolean"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n            which is a /per ...","type":"number","format":"double"},"quantityConcept":{"xml":{"name":"quantityConcept","attribute":false},"description":"Gets or sets the quantity concept ref","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":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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 a material which is manufactured by a particular organization or company.","type":"object"},"Entity":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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 the base class of all entities (persons, places, things) in SanteDB","type":"object"},"TextObservation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"valueType":{"xml":{"name":"valueType","attribute":false},"description":"Value type","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the textual value","type":"string"},"interpretationConcept":{"xml":{"name":"interpretationConcept","attribute":false},"description":"Gets or sets the interpretation concept","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/definitions/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/definitions/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/definitions/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/definitions/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/definitions/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/definitions/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/definitions/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/definitions/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 observation with a text value","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"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":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"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":"Used to link two or more acts together","type":"object"},"PlaceService":{"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"},"serviceConcept":{"xml":{"name":"serviceConcept","attribute":false},"description":"Gets or sets the service concept key","type":"string","format":"uuid"},"serviceSchedule":{"xml":{"name":"serviceSchedule","attribute":false},"description":"The schedule that the service is offered","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 service for a place","type":"object"},"NameValueCollection":{"properties":{},"type":"object"},"CodedObservation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"valueType":{"xml":{"name":"valueType","attribute":false},"description":"Value type","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the key of the uom concept","type":"string","format":"uuid"},"interpretationConcept":{"xml":{"name":"interpretationConcept","attribute":false},"description":"Gets or sets the interpretation concept","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/definitions/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/definitions/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/definitions/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/definitions/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/definitions/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/definitions/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/definitions/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/definitions/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 observation with a concept value","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":"#/definitions/PatchTarget"}},"change":{"xml":{"name":"change","attribute":false},"description":"A list of patch operations to be applied to the object","type":"array","items":{"$ref":"#/definitions/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"},"ConceptReferenceTerm":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"term":{"xml":{"name":"term","attribute":false},"description":"Gets or sets the reference term identifier","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Gets or sets the relationship type identifier","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 reference term relationship between a concept and reference term","type":"object"},"SubstanceAdministration":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"route":{"xml":{"name":"route","attribute":false},"description":"Gets or sets the key for route","type":"string","format":"uuid"},"doseUnit":{"xml":{"name":"doseUnit","attribute":false},"description":"Gets or sets the key for dosing unit","type":"string","format":"uuid"},"doseQuantity":{"xml":{"name":"doseQuantity","attribute":false},"description":"Gets or sets the amount of substance administered","type":"number","format":"double"},"doseSequence":{"xml":{"name":"doseSequence","attribute":false},"description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"number","format":"int32"},"site":{"xml":{"name":"site","attribute":false},"description":"Gets or sets the site","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/definitions/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/definitions/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/definitions/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/definitions/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/definitions/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/definitions/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/definitions/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/definitions/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 act whereby a substance is administered to the patient","type":"object"},"PatchCollection":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"patch":{"xml":{"name":"patch","attribute":false},"description":"Gets or sets the patches","type":"array","items":{"$ref":"#/definitions/Patch","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"type":"string","format":"date"},"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 collection of patch instructions","type":"object"},"DeviceEntity":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"manufacturerModelName":{"xml":{"name":"manufacturerModelName","attribute":false},"description":"Gets or sets the manufacturer model name","type":"string"},"operatingSystemName":{"xml":{"name":"operatingSystemName","attribute":false},"description":"Gets or sets the operating system name","type":"string"},"securityDevice":{"xml":{"name":"securityDevice","attribute":false},"description":"Gets or sets the security device key","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":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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 a device entity","type":"object"},"ServiceOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"version":{"xml":{"name":"version","attribute":true},"description":"Gets or sets the version of the service interface","type":"string"},"server":{"xml":{"name":"server","attribute":true},"description":"Gets the server informational version","type":"string"},"resource":{"xml":{"name":"resource","attribute":false},"description":"Gets the service resource options","type":"array","items":{"$ref":"#/definitions/ServiceResourceOptions","type":"object"}},"endpoint":{"xml":{"name":"endpoint","attribute":false},"description":"Gets or sets the endpoint options","type":"array","items":{"$ref":"#/definitions/ServiceEndpointOptions","type":"object"}},"settings":{"xml":{"name":"settings","attribute":false},"description":"Gets or sets the flags on the service","type":"array","items":{"$ref":"#/definitions/AppSettingKeyValuePair","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets the modified on date time of the service options.","type":"string","format":"date"},"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":"Service options","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":"#/definitions/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/definitions/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","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":"#/definitions/Parameter","type":"object"}}},"description":"Gets the operation invokation","type":"object"},"StockLedgerEntry":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this entry in the ledger","type":"number","format":"int64"},"act":{"xml":{"name":"act","attribute":false},"description":"Gets or sets the act which caused this ledger entry to be created","type":"string","format":"uuid"},"container":{"xml":{"name":"container","attribute":false},"description":"Gets or sets the container to which this ledger entry applies","type":"string","format":"uuid"},"material":{"xml":{"name":"material","attribute":false},"description":"Gets or sets the material to which the ledger entry applies","type":"string","format":"uuid"},"reason":{"xml":{"name":"reason","attribute":false},"description":"Gets or sets the reason for the ledger entry","type":"string","format":"uuid"},"startOfLine":{"xml":{"name":"startOfLine","attribute":false},"description":"Gets or sets the start of line balance (the known balance before the entry was created)","type":"number","format":"int32"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Gets or sets the quantity of the current ledger entry","type":"number","format":"int32"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security principal that was responsible for the cretion of this ledger entry","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the time that this ledger entry was created","type":"string"},"timestamp":{"xml":{"name":"timestamp","attribute":false},"description":"Gets or sets the timestamp when the ledger entry applies to","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the modification date of this object entry","type":"string","format":"date"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the stock ledger entry type","type":"string","enum":["ledger","rollback","purged"]},"ref":{"xml":{"name":"ref","attribute":false},"description":"If this entry points to another entry, then the pointer to the entry being referenced","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 stock ledger entry","type":"object"},"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":"#/definitions/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":"#/definitions/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":"#/definitions/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/definitions/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/definitions/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/definitions/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":"#/definitions/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":"#/definitions/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":"#/definitions/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/definitions/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"},"QuantityObservation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the observed quantity","type":"number","format":"double"},"valueType":{"xml":{"name":"valueType","attribute":false},"description":"Value type","type":"string"},"unitOfMeasure":{"xml":{"name":"unitOfMeasure","attribute":false},"description":"Gets or sets the key of the uom concept","type":"string","format":"uuid"},"interpretationConcept":{"xml":{"name":"interpretationConcept","attribute":false},"description":"Gets or sets the interpretation concept","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/definitions/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/definitions/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/definitions/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/definitions/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/definitions/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/definitions/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/definitions/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/definitions/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 observation that contains a quantity","type":"object"},"PatientEncounter":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"dischargeDisposition":{"xml":{"name":"dischargeDisposition","attribute":false},"description":"Gets or sets the key of discharge disposition","type":"string","format":"uuid"},"admissionSource":{"xml":{"name":"admissionSource","attribute":false},"description":"Gets or sets the admission source type","type":"string","format":"uuid"},"specialArrangement":{"xml":{"name":"specialArrangement","attribute":false},"description":"A list of special arrangements which are to be made to the patient during the encounter","type":"array","items":{"$ref":"#/definitions/PatientEncounterArrangement","type":"object"}},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/definitions/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/definitions/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/definitions/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/definitions/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/definitions/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/definitions/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/definitions/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/definitions/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/definitions/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 encounter a patient has with the health system","type":"object"},"ConceptSetComposition":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"instruction":{"xml":{"name":"instruction","attribute":false},"description":"The composition operation","type":"string","enum":["include","exclude"]},"target":{"xml":{"name":"target","attribute":false},"description":"Gets the target of the composition","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 reference between two different concept sets","type":"object"},"ConceptName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"language":{"xml":{"name":"language","attribute":false},"description":"Gets or sets the language code of the object","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the name of the reference term","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 (human name) that a concept may have","type":"object"},"ReferenceTermName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"language":{"xml":{"name":"language","attribute":false},"description":"Gets or sets the language code of the object","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the name of the reference term","type":"string"},"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":"Display name of a code system or reference term","type":"object"},"ActIdentifier":{"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":"#/definitions/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":"Act identifier","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol  to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","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 information related to the clinical protocol to which an act is a member of","type":"object"},"ServiceEndpointOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":true},"description":"The classification of the service (such as HDSI, AMI, IDP, etc.) which this registration represents","type":"string","enum":["hdsi","risi","ami","pixpdq","fhir","v2","gs1","acs","meta","bis","other","app","web"]},"cap":{"xml":{"name":"cap","attribute":true},"description":"The capabilities of this service (compression, bearer authentication, etc.) which is used by clients to negotiate server capacity","type":"string","enum":["none","basic","bearer","compress","nodeauth","cors","viewModel","standardApi","standardApiCors","internalApi","idpApi"]},"security":{"xml":{"name":"security","attribute":true},"description":"Identifies the security methods on the provider","type":"string","enum":["None","Basic","Bearer","ClientCertificate"]},"url":{"xml":{"name":"url","attribute":true},"description":"The URLs where the remote service described by the service type can be accessed","type":"array","items":{"type":"string"}},"contract":{"xml":{"name":"contract","attribute":false},"description":"Gets or sets the contract","type":"array","items":{"$ref":"#/definitions/TypeReferenceConfiguration","type":"object"}},"behavior":{"xml":{"name":"behavior","attribute":false},"description":"The service implementation which this remote service implements (which is used to drive metadata collection)","schema":{"$ref":"#/definitions/TypeReferenceConfiguration"}}},"description":"Service endpoint options","type":"object"},"PatientEncounterArrangement":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the arrangement made","type":"string","format":"uuid"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","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":"Links a","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"},"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":"#/definitions/Object"}}},"description":"REST service fault wrapper","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":"#/definitions/Object"}}},"description":"Represents a single patch operation","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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"},"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 on an act","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"},"ActNote":{"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"},"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"},"ConceptTag":{"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 concept","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":"#/definitions/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"},"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":"#/definitions/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"},"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"},"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"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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"},"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"},"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"},"ActExtension":{"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":"Act extension","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"},"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"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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":"#/definitions/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"},"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"},"AppSettingKeyValuePair":{"xml":{"attribute":false,"namespace":"http://santedb.org/configuration"},"properties":{"key":{"xml":{"name":"key","attribute":true},"description":"The key of the setting","type":"string"},"value":{"xml":{"name":"value","attribute":true},"description":"The value of the setting","type":"string"}},"description":"Application key/value pair setting","type":"object"},"ServiceResourceOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"resource":{"xml":{"name":"resource","attribute":true},"description":"Gets the name of the resource","type":"string"},"cap":{"xml":{"name":"cap","attribute":false},"description":"Gets or sets the operations supported by this resource","type":"array","items":{"$ref":"#/definitions/ServiceResourceCapability","type":"object"}},"children":{"xml":{"name":"children","attribute":false},"description":"Gets the resources which are associated with this resource (sub-resources)","type":"array","items":{"$ref":"#/definitions/ChildServiceResourceOptions","type":"object"}}},"description":"Service resource options","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"},"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"},"ServiceResourceCapability":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"cap":{"xml":{"name":"cap","attribute":true},"description":"Gets or sets the capabilities","type":"string","enum":["none","create","create-update","update","delete","patch","get","get-version","history","search"]},"demand":{"xml":{"name":"demand","attribute":false},"description":"Gets or sets the demand","type":"array","items":{"type":"string"}}},"description":"Service resource options","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"},"ChildServiceResourceOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"scope":{"xml":{"name":"scope","attribute":true},"description":"Gets or sets the scope of this object.","type":"string","enum":["instance","class"]},"classification":{"xml":{"name":"classification","attribute":true},"description":"Gets or sets the classification of this object","type":"string","enum":["resource","operation"]},"resource":{"xml":{"name":"resource","attribute":true},"description":"Gets the name of the resource","type":"string"},"cap":{"xml":{"name":"cap","attribute":false},"description":"Gets or sets the operations supported by this resource","type":"array","items":{"$ref":"#/definitions/ServiceResourceCapability","type":"object"}},"children":{"xml":{"name":"children","attribute":false},"description":"Gets the resources which are associated with this resource (sub-resources)","type":"array","items":{"$ref":"#/definitions/ChildServiceResourceOptions","type":"object"}}},"description":"Child service resource options","type":"object"},"TypeReferenceConfiguration":{"xml":{"attribute":false,"namespace":"http://santedb.org/configuration"},"properties":{"type":{"xml":{"name":"type","attribute":true},"description":"Gets the type","type":"string"}},"description":"Represents a class that can be used to reference types in configuration files","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"}},"securityDefinitions":{"svc_auth":{"type":"oauth2","flow":"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.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.52820.5.10":"Access All Experimental Features","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.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.100":"Access All SanteDB Tools","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.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.52820.5.10.1":"Access All Experimental EMR Features","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","2.25.70100936533247523356621147216786164046":"Emergency Use Only","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","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.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.52820.5.10.2":"Access All Experimental IMS Features"}}},"tags":[{"description":"Represents the base class for an act (something which is done or actioned on)","name":"Act"},{"description":"Used to link two or more acts together","name":"ActRelationship"},{"description":"Represents the clinical data object for Applications","name":"ApplicationEntity"},{"description":"A bundle represents a batch of objects which are included within the bundle","name":"Bundle"},{"description":"Represents a single care pathway","name":"CarePathwayDefinition"},{"description":"Represents a care plan","name":"CarePlan"},{"description":"Represents an observation with a concept value","name":"CodedObservation"},{"description":"Represents a code system which is a collection of reference terms","name":"CodeSystem"},{"description":"A class representing a generic concept used in the SanteDB datamodel","name":"Concept"},{"description":"Identifies a classification for a concept","name":"ConceptClass"},{"description":"Extension bound to entity","name":"ConceptExtension"},{"description":"Represents a reference term relationship between a concept and reference term","name":"ConceptReferenceTerm"},{"description":"Represents a relationship between two concepts","name":"ConceptRelationship"},{"description":"Concept relationship type","name":"ConceptRelationshipType"},{"description":"Represents set of concepts","name":"ConceptSet"},{"description":"Represents a container.","name":"Container"},{"description":"Represents an observation which contains a date value","name":"DateObservation"},{"description":"Represents a device entity","name":"DeviceEntity"},{"description":"Associates a","name":"DeviceMailbox"},{"description":"Represents the base class of all entities (persons, places, things) in SanteDB","name":"Entity"},{"description":"Extension bound to entity","name":"EntityExtension"},{"description":"Represents an association between two entities","name":"EntityRelationship"},{"description":"Instructions on how an extensionshould be handled","name":"ExtensionType"},{"description":"Represents a model class which is an assigning authority","name":"IdentityDomain"},{"description":"Represents a mailbox - a particular folder or place which holds","name":"Mailbox"},{"description":"Associates a","name":"MailboxMailMessage"},{"description":"Represents an alert message.","name":"MailMessage"},{"description":"Represents a material which is manufactured by a particular organization or company.","name":"ManufacturedMaterial"},{"description":"Represents a material which describes a type of material (i.e. scapel, antigen, etc.) and serves as a base class for manufactured materials","name":"Material"},{"description":"Represents a narrative object in the reference model","name":"Narrative"},{"description":"Represents a act (","name":"Observation"},{"description":"Organization entity","name":"Organization"},{"description":"Represents an entity which is a patient","name":"Patient"},{"description":"Represents an encounter a patient has with the health system","name":"PatientEncounter"},{"description":"Represents an entity which is a person","name":"Person"},{"description":"An entity which is a place where healthcare services are delivered","name":"Place"},{"description":"Represents a service for a place","name":"PlaceService"},{"description":"Represents a class which has an immediate and primary outcome and is an alteration\r\n            of the physical condition of the subject.","name":"Procedure"},{"description":"Represents the model of a clinical protocol for CDR","name":"Protocol"},{"description":"Represents a provider role of a person","name":"Provider"},{"description":"Represents an observation that contains a quantity","name":"QuantityObservation"},{"description":"Represents a basic reference term","name":"ReferenceTerm"},{"description":"Represents a stock ledger entry","name":"StockLedgerEntry"},{"description":"Represents an act whereby a substance is administered to the patient","name":"SubstanceAdministration"},{"description":"Represents a template definition","name":"TemplateDefinition"},{"description":"Represents an observation with a text value","name":"TextObservation"},{"description":"Represents a user entity","name":"UserEntity"}],"produces":["application/json","application/x.santedb.rim.viewModel+json","application/xml"],"consumes":["application/x.santedb.rim.viewModel+json","application/json","application/xml"]}