| Common to All message types |
Output Contextual Informations | |||
| label | path | description | possible values | |
| is XUA | useXUA | indicates whether the simulator must turn XUA mode on or off |
true or false | |
| STS Provider | STSProvider | required if useXUA = true STS endpoint |
STS endpoint wsdl | |
| Pratician ID | subject:subject-id | required if useXUA = true HPC unique ID used to request the XUA assertion |
ID is usually format as an email | |
| Prupose of use | subject:purposeofuse | ex: Treatment | ||
| Pratician Role | subject:role | HPC role | Nurse, admin, Physician, Pharmacist | |
| HCO | subject:organization | HCO | ||
| HCO's OID | subject:organization-id | OID of the HCO | begins with urn:oid: | |
| Facility Type | subject:healthcare-facility-type | |||
| HCO's Locality | environment:locality | |||
| FindDocuments | Output Contextual Informations | |||
| label | path | description | possible values | |
| patientUniqueId | $XDSDocumentEntryPatientId | id of a patient known by the Responding Gateway |
normalized patient unique id | |
| maxResults | maxResults | max number of returned results | will be 10 by default | |
| Input Contextual Informations | ||||
| label | path | description | possible values | |
| Response Status Type | status | ResponseStatusType contained in the response returned by the Responding Gateway |
Success, Partial Success, Failure | |
| Document UUIDs | uuids | List of document UUIDs returns by the FindDocuments response, in the limit of the maxResults defined. |
||
| GetDocuments | Output Contextual Informations | |||
| label | path | description | possible values | |
| Document UUIDs | $XDSDocumentEntryEntryUUID | makes a reference to the documentUUIDs Returned by FindDocuments |
||
| homeCommunityId | home | id of the community the responder belongs to | normalized uuid | |
| Input Contextual Informations | ||||
| label | path | description | possible values | |
| documentUniqueIds | documentUniqueId | List of document unique Ids | ||
| repositoryUniqueId | repositoryUniqueId | repositoryUniqueId | ||
| ResponseStatusType | status | ResponseStatusType contained in the response returned by the Responding Gateway |
Success, Partial Success, Failure | |
| GetRelated | Output Contextual Informations | |||
| label | path | description | possible values | |
| documentUUID | $XDSDocumentEntryEntryUUID | document UUID | ||
| homeCommunityId | home | id of the community the responder belongs to | ||
| associationTypes | $AssociationTypes | List of association types separated by coma | APND, RPLC, XFRM, XFRM_RPLC, signs |
|
| Input Contextual Informations | ||||
| label | path | description | possible values | |
| ResponseStatusType | status | ResponseStatusType contained in the response returned by the Responding Gateway |
Success, Partial Success, Failure | |
| GetSubmissionSets | Output Contextual Informations | |||
| label | path | description | possible values | |
| useXUA | useXUA | indicates whether the simulator must turn XUA mode on or off |
true or false | |
| documentUUID | $uuid | document UUID | ||
| homeCommunityId | home | id of the community the responder belongs to | ||
| Input Contextual Informations | ||||
| label | path | description | possible values | |
| ResponseStatusType | status | ResponseStatusType contained in the response returned by the Responding Gateway |
Success, Partial Success, Failure | |
| GetAssociations | Output Contextual Informations | |||
| label | path | description | possible values | |
| documentUUID | $uuid | document UUID | ||
| homeCommunityId | home | id of the community the responder belongs to | ||
| Input Contextual Informations | ||||
| label | path | description | possible values | |
| ResponseStatusType | status | ResponseStatusType contained in the response returned by the Responding Gateway |
Success, Partial Success, Failure | |
| ITI-39 | Output Contextual Informations | |||
| label | path | description | possible values | |
| documentUniqueIds | documentUniqueId | Id of the document to retrieve | taken from GetDocuments response | |
| repositoryUniqueId | repositoryUniqueId | id of the repository linked to the Responding Gateway |
taken from GetDocuments response | |
| homeCommunityId | homeCommunityId | id of the community the responder belongs to | normalized uuid | |
| Input Contextual Informations | ||||
| label | path | description | possible values | |
| ResponseStatusType | status | ResponseStatusType contained in the response returned by the Responding Gateway |
Success, Partial Success, Failure | |