200
- On success
|
number |
integer |
*
|
Numeric unique identifier used in frontend (sequential without gaps) [not empty] |
hash |
string |
*
|
Unique identifier used in API (non-sequential with gaps) [not empty] |
status |
integer |
*
|
Enumeration: 2=validated, 3=pending, 4=confirmed, 5=archived, 6=anonymised [not empty] |
type |
integer |
*
|
Enumeration: 1=institution, 2=medic, 3=private. Applications of different types have different structure. See other GET resources below. [not empty] |
specialty |
integer |
*
|
Enumeration: 1=no specialty, 2=kispi (child care), 3=seop (oncology care), 4=assistence (consultation and support services). [not empty] |
modified |
DateTime |
*
|
Date/time of last modification by OPAN users/system [not empty] |
created |
DateTime |
*
|
Date/time of application creation through OPAN system [not empty] |
internalInfo |
string |
*
|
Internal information set by organisation |
deadline |
DateTime |
*
|
The date and time until which this application must have been confirmed by the assigned organisation [not empty] |
visitation |
object (Visitation) |
*
|
|
visitation[preferredDate] |
DateTime |
*
|
Preferred date of Spitex visitation |
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[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) [not empty] |
visitation[exitDate] |
DateTime |
*
|
Release date from hospital/institution |
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] |
client[medicFallback] |
string |
*
|
Fallback plaintext information about the client's medic that is displayed when the medic couldn't be resolved properly. |
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 |
care |
object (InstitutionCare) |
*
|
|
care[diagnosis] |
string |
*
|
[not empty] |
care[reason] |
string |
*
|
[not empty for private applications] |
care[basicCare] |
object (BasicCare) |
*
|
|
care[basicCare][activated] |
boolean |
*
|
|
care[basicCare][description] |
string |
*
|
[not empty if basicCare activated] |
care[housework] |
object (Housework) |
*
|
|
care[housework][activated] |
boolean |
*
|
|
care[housework][description] |
string |
*
|
|
care[housework][services][] |
array of integers |
*
|
[not empty if housework activated] |
care[medicalCare] |
object (MedicalCare) |
*
|
|
care[medicalCare][activated] |
boolean |
*
|
|
care[medicalCare][description] |
string |
*
|
[not empty if medicalCare activated] |
care[medicalCare][other] |
string |
*
|
[not empty if medicalCare activated and medicSupply = 3] |
care[medicalCare][medicSupply] |
integer |
*
|
[not empty if medicalCare activated] |
care[acuteCareTransition] |
boolean |
*
|
|
contactInfo |
object (MedicContactInfo) |
*
|
|
contactInfo[firstName] |
string |
*
|
[not empty] |
contactInfo[lastName] |
string |
*
|
[not empty] |
contactInfo[phoneNumber] |
string |
*
|
[not empty] |
contactInfo[additionalPhoneNumber] |
string |
*
|
|
contactInfo[primaryMail] |
string |
*
|
[not empty] |
contactInfo[mails][] |
array of strings |
*
|
|
contactInfo[availability] |
object (Availability) |
*
|
|
contactInfo[availability][weekDays][] |
array of integers |
*
|
[not empty] |
contactInfo[availability][text] |
string |
*
|
[not empty] |
contactInfo[availability][callBack] |
boolean |
*
|
|
contactInfo[info] |
string |
*
|
|
contactInfo[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] |
contactInfo[medic] |
object (Medic) |
*
|
Can be null if the medic was not found in SASIS directory. See medicNotFound field below. [not empty if medicNotFound is empty] |
contactInfo[medic][address] |
object (PlainAddress) |
*
|
|
contactInfo[medic][address][street] |
string |
*
|
|
contactInfo[medic][address][houseNumber] |
string |
*
|
|
contactInfo[medic][address][addressSupplement] |
string |
*
|
|
contactInfo[medic][address][zip] |
integer |
*
|
The postal code of the town or village (ignored in patch request) |
contactInfo[medic][address][location] |
string |
*
|
The town or village name (ignored in patch request) |
contactInfo[medic][firstName] |
string |
*
|
|
contactInfo[medic][lastName] |
string |
*
|
|
contactInfo[medic][zsr] |
string |
*
|
|
contactInfo[medicNotFound] |
string |
*
|
If the responsible medic was not found in the SASIS directory, this field will contain further information. [not empty if medic is empty] |
contactInfo[function] |
string |
*
|
Function/position of the contact person |
contactInfo[practice] |
object (Practice) |
*
|
|
contactInfo[practice][uid] |
string |
*
|
Unique identifier |
contactInfo[practice][zsr] |
string |
*
|
|
contactInfo[practice][gln] |
string |
*
|
|
contactInfo[practice][name] |
string |
*
|
|
contactInfo[practice][phone_number] |
string |
*
|
|
contactInfo[practice][email] |
string |
*
|
|
contactInfo[practice][address] |
object (LocalityAddress) |
*
|
|
contactInfo[practice][address][street] |
string |
*
|
[not empty] |
contactInfo[practice][address][houseNumber] |
string |
*
|
|
contactInfo[practice][address][addressSupplement] |
string |
*
|
|
contactInfo[practice][address][latitude] |
string |
*
|
|
contactInfo[practice][address][longitude] |
string |
*
|
|
contactInfo[practice][address][zip] |
integer |
*
|
The postal code of the town or village (ignored in patch request) [not empty] |
contactInfo[practice][address][location] |
string |
*
|
The town or village name (ignored in patch request) [not empty] |