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 |
residence |
object (Residence) |
*
|
|
residence[entryDate] |
DateTime |
*
|
|
residence[exitDate] |
DateTime |
*
|
|
residence[stayPeriod] |
integer |
*
|
|
residence[urgent] |
boolean |
*
|
|
residence[dwellingForms][] |
array of objects (int) |
*
|
|
patient |
object (Patient) |
*
|
|
patient[firstName] |
string |
*
|
|
patient[lastName] |
string |
*
|
|
patient[gender] |
integer |
*
|
Enumeration: 1=male, 2=female |
patient[birthday] |
DateTime |
*
|
|
patient[socialSecurityNumber] |
string |
*
|
|
patient[patientData] |
object (PatientData) |
*
|
|
patient[patientData][socialWelfare] |
integer |
*
|
Enumeration: 1=yes, 2=no, 3=requested, 4=unknown |
patient[patientData][maritalState] |
integer |
*
|
Enumeration: 1=separated, 2=divorced, 3=married, 4=single, 5=widowed, 6=legal separation, 7=unknown, 8=other |
patient[patientData][denomination] |
integer |
*
|
Enumeration: 1=roman_catholic, 2=reformed_protestant, 3=christian_orthodox, 4=other_christian, 5=muslim, 6=buddhist, 7=hindu, 8=jewish, 9=other, 10=undenominational, 11=unknown |
patient[patientData][language] |
integer |
*
|
Enumeration: 1=German, 2=French, 3=Italian, 4=English, 5=Albanian, 6=Portuguese, 7=Serbo-Croatian, 8=Spanish, 9=Turkish, 10=other |
patient[patientData][address] |
object (AddressComplete) |
*
|
|
patient[patientData][address][street] |
string |
*
|
|
patient[patientData][address][houseNumber] |
string |
*
|
|
patient[patientData][address][addressSupplement] |
string |
*
|
|
patient[patientData][address][zip] |
integer |
*
|
The postal code of the town or village |
patient[patientData][address][location] |
string |
*
|
The town or village name |
patient[patientData][address][canton] |
string |
*
|
|
patient[patientData][address][country] |
string |
*
|
|
patient[patientData][phoneNumber] |
string |
*
|
|
patient[patientData][additionalPhoneNumber] |
string |
*
|
|
patient[patientData][email] |
string |
*
|
|
patient[patientData][insurance] |
object (Insurance) |
*
|
|
patient[patientData][insurance][insurer] |
string |
*
|
GLN/ZSR number of the insurance company. Valid numbers can be obtained from SASIS AG |
patient[patientData][insurance][insuranceNumber] |
string |
*
|
Number of the insurance contract |
patient[patientData][insurance][vekaNumber] |
string |
*
|
|
patient[patientData][insurance][vekaExpiration] |
DateTime |
*
|
|
patient[patientData][insurance][insuranceType] |
integer |
*
|
Enumeration: 1=general, 2=semi_private, 3=private, 4=unknown |
patient[patientData][insurance][additionalInsurer] |
string |
*
|
GLN/ZSR number of the insurance company. Valid numbers can be obtained from SASIS AG |
patient[patientData][insurance][additionalInsuranceNumber] |
string |
*
|
Number of the additional insurance contract |
patient[patientData][primaryContact] |
object (PrimaryContact) |
*
|
|
patient[patientData][primaryContact][customer] |
boolean |
*
|
|
patient[patientData][primaryContact][lastName] |
string |
*
|
|
patient[patientData][primaryContact][firstName] |
string |
*
|
|
patient[patientData][primaryContact][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, 13=my_self |
patient[patientData][primaryContact][phoneNumber] |
string |
*
|
|
patient[patientData][primaryContact][email] |
string |
*
|
|
patient[patientData][primaryContact][address] |
object (Address) |
*
|
|
patient[patientData][primaryContact][address][street] |
string |
*
|
|
patient[patientData][primaryContact][address][houseNumber] |
string |
*
|
|
patient[patientData][primaryContact][address][addressSupplement] |
string |
*
|
|
patient[patientData][primaryContact][address][zip] |
integer |
*
|
The postal code of the town or village |
patient[patientData][primaryContact][address][location] |
string |
*
|
The town or village name |
patient[patientData][relatives][] |
array of objects (Relative) |
*
|
|
patient[patientData][relatives][][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, 13=my_self |
patient[patientData][relatives][][firstName] |
string |
*
|
|
patient[patientData][relatives][][lastName] |
string |
*
|
|
patient[patientData][relatives][][phoneNumber] |
string |
*
|
|
patient[patientData][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 |
care |
object (Care) |
*
|
|
care[careIntensity] |
integer |
*
|
Enumeration: 1=low, 2=medium, 3=high, 4=unknown |
care[careSpecialties][] |
array of objects (int) |
*
|
|
care[spitexAssistance] |
boolean |
*
|
|
care[spitexOrganisation] |
string |
*
|
ZSR or GLN number of the client's Spitex organisation. Valid numbers can be by searching in the /organisations resource |
care[diagnosis] |
string |
*
|
|
care[careInstruction] |
string |
*
|
|
care[medicineSupply] |
integer |
*
|
Enumeration: 1=has_medic, 2=medic_supplied, 3=other |
care[medicineOther] |
string |
*
|
|
care[careReports][] |
array of objects (Document) |
*
|
|
care[careReports][][name] |
string |
*
|
Document file name as specified during upload |
care[careReports][][type] |
string |
*
|
Document media type as specified during upload |
care[careReports][][size] |
string |
*
|
Document size in bytes |
care[careReports][][hash] |
string |
*
|
Unique identifier for document |
care[medications][] |
array of objects (Document) |
*
|
|
care[medicalCertificate] |
object (Document) |
*
|
|
care[patientDecree] |
object (Document) |
*
|
|
care[healthCareProxy] |
object (Document) |
*
|
|
care[additionalDocuments][] |
array of objects (Document) |
*
|
|
status |
integer |
*
|
Enumeration: 1=temporary, 9=unvalidated, 2=new, 3=pending, 4=confirmed, 5=archived, 6=anonymized, 7=invalid, 8=declined |
submitterType |
integer |
*
|
Enumeration: 1=institution, 2=medic, 3=person. Applications of different types have different structure. |
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). |
modified |
DateTime |
*
|
Date/time of last modification by OPAN users/system |
created |
DateTime |
*
|
Date/time of application creation through OPAN system |
url |
string |
*
|
Link to web-gui for partial API workflow. Also used for additional data form after application is complete. |
allowManualUploads |
boolean |
*
|
Toggles the upload widget for additional documents in the frontend form (default true=on) |
contactInfo |
object (InstitutionContactInfo) |
*
|
|
contactInfo[firstName] |
string |
*
|
|
contactInfo[lastName] |
string |
*
|
|
contactInfo[phoneNumber] |
string |
*
|
|
contactInfo[additionalPhoneNumber] |
string |
*
|
|
contactInfo[primaryMail] |
string |
*
|
|
contactInfo[mails][] |
array of strings |
*
|
|
contactInfo[availability] |
object (Availability) |
*
|
|
contactInfo[availability][weekDays][] |
array of integers |
*
|
|
contactInfo[availability][text] |
string |
*
|
|
contactInfo[availability][callBack] |
boolean |
*
|
|
contactInfo[info] |
string |
*
|
|
contactInfo[language] |
integer |
*
|
|
contactInfo[mailNotification] |
boolean |
*
|
Turns e-mail notification about application status on or off (default false=off) |
contactInfo[institutionIdentifier] |
string |
*
|
|
contactInfo[technicalOu] |
string |
*
|
|
contactInfo[department] |
string |
*
|
|
contactInfo[technicalOrganisationUnit] |
string |
*
|
|
contactInfo[institution] |
string |
*
|
|
contactInfo[internalIdentification] |
string |
*
|
|
contactInfo[caseIdentification] |
string |
*
|
|