200
- On success
|
id |
string |
*
|
This field can be used to store a custom identifier for the application (for internal processing in your own software). |
number |
integer |
*
|
Numeric unique identifier used in frontend. Null as long as application status is temporary (8). |
hash |
string |
*
|
Unique OPAN identifier |
status |
integer |
*
|
Enumeration: 1=unvalidated, 2=validated, 3=pending, 4=confirmed, 5=archived, 6=anonymised, 7=invalid, 8=temporary |
type |
integer |
*
|
Enumeration: 1=institution, 2=medic, 3=person. Applications of different types have different structure. |
specialty |
integer |
*
|
Enumeration: 1=no specialty, 2=kispi (child care), 3=seop (oncology care, not implemented). Assumes 1 if not sent |
externalProcessing |
boolean |
*
|
If this flag is set, application is processed outside of opan and all further data beyond initial submit will be discarded |
visitation |
object (Visitation) |
*
|
|
visitation[type] |
integer |
*
|
Preferred type of visitation date/time arrangement. Enumeration: 1=to be discussed with customer, 2=as soon as possible, 3=as specified (see preferredDate and preferredTime fields) |
visitation[preferredDate] |
DateTime |
*
|
|
visitation[preferredTime] |
integer |
*
|
Preferred time range of Spitex visitation. Enumeration: 1=0600-1000, 2=1000-1200, 3=1200-1300, 4=1300-1700, 5=1700-2200, 6=2200-0600 |
visitation[exitDate] |
DateTime |
*
|
|
client |
object (Client) |
*
|
|
client[firstName] |
string |
*
|
[not empty] |
client[lastName] |
string |
*
|
[not empty] |
client[phoneNumber] |
string |
*
|
[not empty] |
client[additionalPhoneNumber] |
string |
*
|
|
client[email] |
string |
*
|
|
client[birthday] |
DateTime |
*
|
[not empty] |
client[socialSecurityNumber] |
string |
*
|
|
client[gender] |
integer |
*
|
Enumeration: 1=male, 2=female, 3=neutral [not empty] |
client[maritalState] |
integer |
*
|
Enumeration: 1=separated, 2=divorced, 3=married, 4=single, 5=widowed, 6=legal separation, 7=unknown, 8=other [not empty] |
client[language] |
integer |
*
|
Enumeration: 1=German, 2=French, 3=Italian, 4=English, 5=Albanian, 6=Portuguese, 7=Serbo-Croatian, 8=Spanish, 9=Turkish, 10=other [not empty] |
client[address] |
object (LocalityAddress) |
*
|
|
client[address][street] |
string |
*
|
[not empty] |
client[address][houseNumber] |
string |
*
|
|
client[address][addressSupplement] |
string |
*
|
|
client[address][latitude] |
string |
*
|
|
client[address][longitude] |
string |
*
|
|
client[address][zip] |
integer |
*
|
The postal code of the town or village (ignored in patch request) [not empty] |
client[address][location] |
string |
*
|
The town or village name (ignored in patch request) [not empty] |
client[insurance] |
object (Insurance) |
*
|
|
client[insurance][incident] |
integer |
*
|
Enumeration: 1=disease, 2=accident, 3=disability, 4=maternity [not empty] |
client[insurance][insurer] |
string |
*
|
GLN/ZSR number of the insurance company. Valid numbers can be obtained from SASIS AG [not empty] |
client[insurance][insuranceNumber] |
string |
*
|
Number of the insurance contract |
client[relative] |
object (Relative) |
*
|
|
client[relative][relationship] |
integer |
*
|
Enumeration: 1=spouse, 2=partner, 3=daughter, 4=son, 5=brother, 6=sister, 7=mother, 8=father, 9=other family member, 10=acquaintance, 11=legal representative, 12=other |
client[relative][firstName] |
string |
*
|
|
client[relative][lastName] |
string |
*
|
|
client[relative][phone] |
string |
*
|
|
client[medic] |
string |
*
|
ZSR or GLN number of the client's family doctor. Valid numbers can be obtained from SASIS AG or by searching in the /medics resource [not empty] |
apiCustomData |
object (ApiCustomData) |
*
|
|
apiCustomData[department] |
string |
*
|
This field can be used to store the name of the department sending the application (for internal processing in your own software). |
apiCustomData[user] |
string |
*
|
This field can be used to store the name of the user sending the application (for internal processing in your own software). |
apiCustomData[data] |
string |
*
|
This field can be used to store any custom text data (for internal processing in your own software). |
documents[] |
array of objects (Document) |
*
|
|
documents[][name] |
string |
*
|
Document file name as specified during upload |
documents[][type] |
string |
*
|
Document media type as specified during upload |
documents[][size] |
string |
*
|
Document size in bytes |
documents[][hash] |
string |
*
|
Unique identifier for document |
modified |
DateTime |
*
|
Date/time of last modification by OPAN users/system |
created |
DateTime |
*
|
Date/time of application creation through OPAN system |
frontendUrl |
string |
*
|
Link to public-gui for partial API workflow. Also used for additional data form after application is complete. |
privateCare |
object (PrivateCare) |
*
|
|
privateCare[diagnosis] |
string |
*
|
[not empty] |
privateCare[reason] |
string |
*
|
[not empty for private applications] |
privateCare[description] |
string |
*
|
Textual description of the desired care tasks. [not empty] |
privateCare[medicInformed] |
boolean |
*
|
Whether the medic of the client has been informed. |
privateContactInfo |
object (PrivateContactInfo) |
*
|
|
privateContactInfo[firstName] |
string |
*
|
|
privateContactInfo[lastName] |
string |
*
|
|
privateContactInfo[phoneNumber] |
string |
*
|
|
privateContactInfo[additionalPhoneNumber] |
string |
*
|
|
privateContactInfo[primaryMail] |
string |
*
|
|
privateContactInfo[mails][] |
array of strings |
*
|
|
privateContactInfo[availability] |
object (Availability) |
*
|
|
privateContactInfo[availability][weekDays][] |
array of integers |
*
|
[not empty] |
privateContactInfo[availability][text] |
string |
*
|
[not empty] |
privateContactInfo[availability][callBack] |
boolean |
*
|
|
privateContactInfo[info] |
string |
*
|
|
privateContactInfo[language] |
integer |
*
|
|
privateContactInfo[mailNotification] |
boolean |
*
|
Turns e-mail notification about application status on or off (default false=off) |
privateContactInfo[gender] |
integer |
*
|
|
privateContactInfo[address] |
object (LocalityAddress) |
*
|
|
privateContactInfo[address][street] |
string |
*
|
[not empty] |
privateContactInfo[address][houseNumber] |
string |
*
|
|
privateContactInfo[address][addressSupplement] |
string |
*
|
|
privateContactInfo[address][latitude] |
string |
*
|
|
privateContactInfo[address][longitude] |
string |
*
|
|
privateContactInfo[address][zip] |
integer |
*
|
The postal code of the town or village (ignored in patch request) [not empty] |
privateContactInfo[address][location] |
string |
*
|
The town or village name (ignored in patch request) [not empty] |
privateContactInfo[relationship] |
integer |
*
|
Enumeration: 1=spouse, 2=partner, 3=daughter, 4=son, 5=brother, 6=sister, 7=mother, 8=father, 9=other family member, 10=acquaintance, 11=legal representative, 12=other [not empty], 13=myself |
privateContactInfo[authority] |
string |
*
|
|
organisation |
object (Organisation) |
*
|
|
organisation[uid] |
string |
*
|
OPAN UID of the Organisation. |
organisation[gln] |
string |
*
|
GLN number of the Organisation. |
organisation[zsr] |
string |
*
|
ZSR number of the Organisation. |
organisation[name] |
string |
*
|
|
organisation[nameFrench] |
string |
*
|
Name of the organisation in French. |
organisation[nameItalian] |
string |
*
|
Name of the organisation in Italian. |
organisation[address] |
object (LocalityAddress) |
*
|
|
organisation[address][street] |
string |
*
|
[not empty] |
organisation[address][houseNumber] |
string |
*
|
|
organisation[address][addressSupplement] |
string |
*
|
|
organisation[address][latitude] |
string |
*
|
|
organisation[address][longitude] |
string |
*
|
|
organisation[address][zip] |
integer |
*
|
The postal code of the town or village (ignored in patch request) [not empty] |
organisation[address][location] |
string |
*
|
The town or village name (ignored in patch request) [not empty] |
organisation[opanEnabled] |
boolean |
*
|
Spitex-Organisation uses OPAN |
organisation[opanLandingPageURL] |
array |
*
|
If opanEnabled, Organisation has a localised landing page on OPAN with a language-specific URL. |
organisation[businessOpenIntervals][] |
array of objects (BusinessOpenInterval) |
*
|
Office hours as reported by the organisation. |
organisation[businessOpenIntervals][][day] |
string |
*
|
Weekday (2-digit). |
organisation[businessOpenIntervals][][start] |
DateTime |
*
|
Start of interval. |
organisation[businessOpenIntervals][][end] |
DateTime |
*
|
End of interval. |
organisation[supplyMandate] |
boolean |
*
|
|
organisation[comparisEnabled] |
boolean |
*
|
Indicates if the organisation agrees to share data with Comparis. |
organisation[comparisRatingsEmail] |
string |
*
|
[optional] can be empty |
organisation[showOnComparis] |
boolean |
*
|
Indicates if Comparis is using OPAN as primary source for this organisation. |
organisation[phoneNumber] |
string |
*
|
|
organisation[faxNumber] |
string |
*
|
|
organisation[email] |
string |
*
|
|
organisation[website] |
string |
*
|
|
organisation[logo] |
string |
*
|
[optional] logo file URL |
organisation[descriptions][] |
array of objects (OrganisationDescription) |
*
|
Organisation self description. |
organisation[descriptions][][lead] |
string |
*
|
Short description (lead). |
organisation[descriptions][][text] |
string |
*
|
More detailled description (can contain HTML code). |
organisation[descriptions][][language] |
object (Language) |
*
|
Language name and code. |
organisation[descriptions][][language][name] |
string |
*
|
Localised name of the language. |
organisation[descriptions][][language][locale] |
string |
*
|
Two-digit language code. |
organisation[services][] |
array of objects (OrganisationService) |
*
|
Service descriptions. |
organisation[services][][id] |
integer |
*
|
ID of the service. |
organisation[services][][serviceName] |
array |
*
|
Array containing the service name's translations. |
organisation[services][][type] |
object (OrganisationServiceType) |
*
|
Basic type of the service (ID enumeration: 1=Grundpflege, 2=Haushalthilfe, 3=Custom, 4=ErweitertePflege, 5=SchuleKindergarten) |
organisation[services][][type][id] |
integer |
*
|
Service type ID. |
organisation[services][][type][typeName] |
array |
*
|
Array containing translations of the service type name. |
organisation[basicServices][] |
array of objects (OrganisationServiceType) |
*
|
Service type descriptions. |
organisation[basicServices][][id] |
integer |
*
|
Service type ID. |
organisation[basicServices][][typeName] |
array |
*
|
Array containing translations of the service type name. |
organisation[publicInfo] |
string |
*
|
|
organisation[minimumPeriodOfTreatment] |
integer |
*
|
Minimum duration for basicServices. |
organisation[processingMinutes] |
integer |
*
|
Running average of minutes an organisation needs to confirm an application. |
organisation[primaryNursing] |
boolean |
<=legacy
|
[Deprecated] If true, the organisation offers personal care ("Bezugspflege"). |
organisation[basicCareServiceAvailable] |
boolean |
*
|
If true, the organisation offers basic Spitex services. |
organisation[treatmentServiceAvailable] |
boolean |
*
|
If true, the organisation offers housework treatment services. |
organisation[houseworkServiceAvailable] |
boolean |
*
|
If true, the organisation offers housework services. |
organisation[lastUpdatedAddress] |
string |
*
|
Timestamp of the last address update. |
organisation[lastUpdatedInformation] |
string |
*
|
Timestamp of the last data update (address changes not included). |
organisation[kispi] |
boolean |
*
|
Spitex-Organisation offers child care |
organisation[seop] |
boolean |
*
|
Spitex-Organisation offers palliative care |
organisation[assistence] |
boolean |
*
|
Organisation offers consultation and assistence services |
organisationUid |
string |
*
|
|