Show/hide List Operations Expand Operations

applications

/api/nursinghome/v2/applications

GET /api/nursinghome/v2/applications

Get applications

Documentation
Sandbox

Documentation

Get list of applications

Parameters

Parameter	Type	Required?	Format	Description
updated	DateTime	false	YYYY-MM-DDTHH:MM:SS	URL-encoded ISO-8601 date. If specified, only applications which are newer than this date will be returned.
offset	integer	false		Only the first 100 results will be returned. With offset, you can skip a number of results from the beginning, e.g. offset 100 returns applications 100-200.

Return

Parameter	Type	Versions	Description
200 - On success
applications[]	array of objects (Application)	*
applications[][number]	integer	*	Numeric unique identifier used in frontend (sequential without gaps)
applications[][hash]	string	*	Unique identifier used in API (non-sequential with gaps)
applications[][status]	integer	*	Enumeration: 2=new, 3=pending, 4=confirmed, 5=archived, 6=anonymized
applications[][type]	integer	*	Enumeration: 1=institution, 2=medic, 3=private. Applications of different types have different structure. See other GET resources below.
applications[][modified]	DateTime	*	Date/time of last modification by OPAN users/system
applications[][created]	DateTime	*	Date/time of application creation through OPAN system

Status Codes

Status Code	Description
200	On success
400	If transmitted parameters are erroneous
401	If ApiKey is unrecognized or ApiUser is disabled

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/applications/institution/{hash}

Get institution application

Documentation
Sandbox

Documentation

Get single application with type 'institution'

Requirements

Name	Requirement	Type	Description
hash	[a-z0-9]+	string	Application unique identifier

Return

Parameter	Type	Versions	Description
200 - On success
number	integer	*	Numeric unique identifier used in frontend (sequential without gaps)
hash	string	*	Unique identifier used in API (non-sequential with gaps)
status	integer	*	Enumeration: 2=new, 3=pending, 4=confirmed, 5=archived, 6=anonymized
type	integer	*	Enumeration: 1=institution, 2=medic, 3=private. Applications of different types have different structure. See other GET resources below.
modified	DateTime	*	Date/time of last modification by OPAN users/system
created	DateTime	*	Date/time of application creation through OPAN system
internalInfo	string	*	Internal information set by facility
deadline	DateTime	*	The date and time until which this application must have been confirmed by the assigned facility
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)	*
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	*	Enumeration: 1=German, 2=French, 3=Italian, 4=English, 5=Albanian, 6=Portuguese, 7=Serbo-Croatian, 8=Spanish, 9=Turkish, 10=other
contactInfo[department]	string	*
contactInfo[institution]	string	*

Status Codes

Status Code	Description
200	On success
401	If ApiKey is unrecognized or ApiUser is disabled
403	If application is not associated with transmitted ApiKey

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/applications/medic/{hash}

Get medic application

Documentation
Sandbox

Documentation

Get single application with type 'medic'

Requirements

Name	Requirement	Type	Description
hash	[a-z0-9]+	string	Application unique identifier

Return

Parameter	Type	Versions	Description
200 - On success
number	integer	*	Numeric unique identifier used in frontend (sequential without gaps)
hash	string	*	Unique identifier used in API (non-sequential with gaps)
status	integer	*	Enumeration: 2=new, 3=pending, 4=confirmed, 5=archived, 6=anonymized
type	integer	*	Enumeration: 1=institution, 2=medic, 3=private. Applications of different types have different structure. See other GET resources below.
modified	DateTime	*	Date/time of last modification by OPAN users/system
created	DateTime	*	Date/time of application creation through OPAN system
internalInfo	string	*	Internal information set by facility
deadline	DateTime	*	The date and time until which this application must have been confirmed by the assigned facility
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)	*
contactInfo	object (MedicContactInfo)	*
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	*	Enumeration: 1=German, 2=French, 3=Italian, 4=English, 5=Albanian, 6=Portuguese, 7=Serbo-Croatian, 8=Spanish, 9=Turkish, 10=other
contactInfo[medic]	object (Medic)	*	Can be null if the medic was not found in SASIS directory. See medicNotFound field below.
contactInfo[medic][address]	object (Address)	*
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
contactInfo[medic][address][location]	string	*	The town or village name
contactInfo[medic][firstName]	string	*
contactInfo[medic][lastName]	string	*
contactInfo[medic][zsr]	string	*
contactInfo[function]	string	*	Function/position of the contact person

Status Codes

Status Code	Description
200	On success
401	If ApiKey is unrecognized or ApiUser is disabled
403	If application is not associated with transmitted ApiKey

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/applications/private/{hash}

Get private application

Documentation
Sandbox

Documentation

Get single application with type 3 = 'private'

Requirements

Name	Requirement	Type	Description
hash	[a-z0-9]+	string	Application unique identifier

Return

Parameter	Type	Versions	Description
200 - On success
number	integer	*	Numeric unique identifier used in frontend (sequential without gaps)
hash	string	*	Unique identifier used in API (non-sequential with gaps)
status	integer	*	Enumeration: 2=new, 3=pending, 4=confirmed, 5=archived, 6=anonymized
type	integer	*	Enumeration: 1=institution, 2=medic, 3=private. Applications of different types have different structure. See other GET resources below.
modified	DateTime	*	Date/time of last modification by OPAN users/system
created	DateTime	*	Date/time of application creation through OPAN system
internalInfo	string	*	Internal information set by facility
deadline	DateTime	*	The date and time until which this application must have been confirmed by the assigned facility
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)	*
contactInfo	object (PrivateContactInfo)	*
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	*	Enumeration: 1=German, 2=French, 3=Italian, 4=English, 5=Albanian, 6=Portuguese, 7=Serbo-Croatian, 8=Spanish, 9=Turkish, 10=other
contactInfo[gender]	integer	*	Enumeration: 1=male, 2=female
contactInfo[address]	object (Address)	*
contactInfo[address][street]	string	*
contactInfo[address][houseNumber]	string	*
contactInfo[address][addressSupplement]	string	*
contactInfo[address][zip]	integer	*	The postal code of the town or village
contactInfo[address][location]	string	*	The town or village name
contactInfo[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
contactInfo[authority]	string	*

Status Codes

Status Code	Description
200	On success
401	If ApiKey is unrecognized or ApiUser is disabled
403	If application is not associated with transmitted ApiKey

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/nursinghome/v2/applications/{hash}

Update an application

Documentation
Sandbox

Documentation

Update an existing application

Requirements

Name	Requirement	Type	Description
hash	\d+	integer	Application hash retrieved from previous GET requests

Parameters

Parameter	Type	Required?	Format	Description
status	integer	false		Enumeration: 3=pending, 4=confirmed. Mark an application as pending or confirmed.
internalInfo	string	false		Custom text that can be stored on the application.

Headers

Name	Required?	Description
Accept-Language	false	One of 'de' (default), 'fr', 'it' or 'en'. Translatable data will be translated using this language.

Status Codes

Status Code	Description
200	On success
400	If transmitted data is erroneous or empty
401	If ApiKey is unrecognized or ApiUser is disabled
403	If application is not associated with transmitted ApiKey or application status does not permit PATCH

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/applications/{hash}/pdf

Get PDF of application

Documentation
Sandbox

Documentation

Get data of a specific application in PDF format. The call will directly return the binary data of the PDF file as a streamed response with Content-Type: application/pdf. The locale-specific data will be returned in the language specified by the Accept-Language header. Possible values are 'de' (default), 'fr', 'it', 'en'.

Requirements

Name	Requirement	Type	Description
hash	[a-z0-9]+	string	Application unique identifier

Status Codes

Status Code	Description
200	On success
400	If transmitted data is erroneous or empty
401	If ApiKey is unrecognized or ApiUser is disabled
403	If application is not associated with transmitted ApiKey or application has not been completed yet

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

document transfers

/api/nursinghome/v2/documenttransfers

GET /api/nursinghome/v2/documenttransfers

Get document transfers

Documentation
Sandbox

Documentation

Get list of document transfers

Parameters

Parameter	Type	Required?	Format	Description
updated	DateTime	false	YYYY-MM-DDTHH:MM:SS	URL-encoded ISO-8601 date. If specified, only document transfers which are newer than this date will be returned.
offset	integer	false		Only the first 100 results will be returned. With offset, you can skip a number of results from the beginning, e.g. offset 100 returns document transfers 100-200.

Return

Parameter	Type	Versions	Description
200 - On success
documentTransfers[]	array of objects (DocumentTransferListItem)	*
documentTransfers[][number]	integer	*	Numeric unique identifier used in frontend (sequential without gaps)
documentTransfers[][hash]	string	*	Unique identifier used in API (non-sequential with gaps)
documentTransfers[][status]	integer	*	Enumeration: 4=delivered, 5=processed, 6=archived, 7=anonymised
documentTransfers[][type]	integer	*	Enumeration: 1=institution, 2=medic, 3=person. Document transfers of different types have different structure.
documentTransfers[][description]	string	*
documentTransfers[][modified]	DateTime	*	Date/time of last modification by OPAN users/system
documentTransfers[][created]	DateTime	*	Date/time of document transfer creation through OPAN system

Status Codes

Status Code	Description
200	On success
400	If transmitted parameters are erroneous
401	If ApiKey is unrecognized or ApiUser is disabled

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/documenttransfers/institution/{hash}

Get institution document transfer

Documentation
Sandbox

Documentation

Get details of a specific document transfer with type institution (1)

Requirements

Name	Requirement	Type	Description
hash	[a-z0-9]+	string	DocumentTransfer unique identifier

Return

Parameter	Type	Versions	Description
200 - On success
number	integer	*	Numeric unique identifier used in frontend (sequential without gaps)
hash	string	*	Unique identifier used in API (non-sequential with gaps)
status	integer	*	Enumeration: 4=delivered, 5=processed, 6=archived, 7=anonymised
type	integer	*	Enumeration: 1=institution, 2=medic, 3=person. Document transfers of different types have different structure.
description	string	*
modified	DateTime	*	Date/time of last modification by OPAN users/system
created	DateTime	*	Date/time of document transfer creation through OPAN system
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
patient	object (Patient)	*
patient[firstName]	string	*
patient[lastName]	string	*
patient[gender]	integer	*	Enumeration: 1=male, 2=female
patient[birthday]	DateTime	*
patient[socialSecurityNumber]	string	*
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	*	Enumeration: 1=German, 2=French, 3=Italian, 4=English, 5=Albanian, 6=Portuguese, 7=Serbo-Croatian, 8=Spanish, 9=Turkish, 10=other
contactInfo[department]	string	*
contactInfo[institution]	string	*

Status Codes

Status Code	Description
200	On success
400	If transmitted parameters are erroneous or resource is not of type institution
401	If ApiKey is unrecognized or ApiUser is disabled
404	If no document transfer with the provided hash is found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/documenttransfers/medic/{hash}

Get medic document transfer

Documentation
Sandbox

Documentation

Get details of a specific document transfer with type medic (2)

Requirements

Name	Requirement	Type	Description
hash	[a-z0-9]+	string	DocumentTransfer unique identifier

Return

Parameter	Type	Versions	Description
200 - On success
number	integer	*	Numeric unique identifier used in frontend (sequential without gaps)
hash	string	*	Unique identifier used in API (non-sequential with gaps)
status	integer	*	Enumeration: 4=delivered, 5=processed, 6=archived, 7=anonymised
type	integer	*	Enumeration: 1=institution, 2=medic, 3=person. Document transfers of different types have different structure.
description	string	*
modified	DateTime	*	Date/time of last modification by OPAN users/system
created	DateTime	*	Date/time of document transfer creation through OPAN system
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
patient	object (Patient)	*
patient[firstName]	string	*
patient[lastName]	string	*
patient[gender]	integer	*	Enumeration: 1=male, 2=female
patient[birthday]	DateTime	*
patient[socialSecurityNumber]	string	*
contactInfo	object (MedicContactInfo)	*
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	*	Enumeration: 1=German, 2=French, 3=Italian, 4=English, 5=Albanian, 6=Portuguese, 7=Serbo-Croatian, 8=Spanish, 9=Turkish, 10=other
contactInfo[medic]	object (Medic)	*	Can be null if the medic was not found in SASIS directory. See medicNotFound field below.
contactInfo[medic][address]	object (Address)	*
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
contactInfo[medic][address][location]	string	*	The town or village name
contactInfo[medic][firstName]	string	*
contactInfo[medic][lastName]	string	*
contactInfo[medic][zsr]	string	*
contactInfo[function]	string	*	Function/position of the contact person

Status Codes

Status Code	Description
200	On success
400	If transmitted parameters are erroneous or resource is not of type institution
401	If ApiKey is unrecognized or ApiUser is disabled
404	If no document transfer with the provided hash is found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/documenttransfers/private/{hash}

Get private document transfer

Documentation
Sandbox

Documentation

Get details of a specific document transfer with type private (3)

Requirements

Name	Requirement	Type	Description
hash	[a-z0-9]+	string	DocumentTransfer unique identifier

Return

Parameter	Type	Versions	Description
200 - On success
number	integer	*	Numeric unique identifier used in frontend (sequential without gaps)
hash	string	*	Unique identifier used in API (non-sequential with gaps)
status	integer	*	Enumeration: 4=delivered, 5=processed, 6=archived, 7=anonymised
type	integer	*	Enumeration: 1=institution, 2=medic, 3=person. Document transfers of different types have different structure.
description	string	*
modified	DateTime	*	Date/time of last modification by OPAN users/system
created	DateTime	*	Date/time of document transfer creation through OPAN system
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
patient	object (Patient)	*
patient[firstName]	string	*
patient[lastName]	string	*
patient[gender]	integer	*	Enumeration: 1=male, 2=female
patient[birthday]	DateTime	*
patient[socialSecurityNumber]	string	*
contactInfo	object (PrivateContactInfo)	*
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	*	Enumeration: 1=German, 2=French, 3=Italian, 4=English, 5=Albanian, 6=Portuguese, 7=Serbo-Croatian, 8=Spanish, 9=Turkish, 10=other
contactInfo[gender]	integer	*	Enumeration: 1=male, 2=female
contactInfo[address]	object (Address)	*
contactInfo[address][street]	string	*
contactInfo[address][houseNumber]	string	*
contactInfo[address][addressSupplement]	string	*
contactInfo[address][zip]	integer	*	The postal code of the town or village
contactInfo[address][location]	string	*	The town or village name
contactInfo[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
contactInfo[authority]	string	*

Status Codes

Status Code	Description
200	On success
400	If transmitted parameters are erroneous or resource is not of type institution
401	If ApiKey is unrecognized or ApiUser is disabled
404	If no document transfer with the provided hash is found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/nursinghome/v2/documenttransfers/{hash}

Update a document transfer

Documentation
Sandbox

Documentation

Update an existing document transfer

Requirements

Name	Requirement	Type	Description
hash	\d+	integer	DocumentTransfer hash retrieved from previous GET requests

Parameters

Parameter	Type	Required?	Format	Description
status	integer	false		Enumeration: 3=pending, 4=confirmed. Mark an application as pending or confirmed.

Headers

Name	Required?	Description
Accept-Language	false	One of 'de' (default), 'fr', 'it' or 'en'. Translatable data will be translated using this language.

Status Codes

Status Code	Description
200	On success
400	If transmitted data is erroneous or empty
401	If ApiKey is unrecognized or ApiUser is disabled
403	If application is not associated with transmitted ApiKey or application status does not permit PATCH

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

documents

GET /api/nursinghome/v2/documents/{hash}

Get document

Documentation
Sandbox

Documentation

Get document with given hash. The call will directly return the binary data of the document as a streamed response with Content-Type set to the media type of the document.

Requirements

Name	Requirement	Type	Description
hash	[a-z0-9]+	string	Document unique identifier

Status Codes

Status Code	Description
401	If ApiKey is unrecognized or ApiUser is disabled
403	If application is not associated with transmitted ApiKey
404	If no document with specified hash was found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

facilities

/api/nursinghome/v2/facilities/all

GET /api/nursinghome/v2/facilities/all

Get all facilities using opan

Documentation
Sandbox

Documentation

Get id and name of all facilities which uses opan

Return

Parameter	Type	Versions	Description
200 - On success
facilities[]	array of objects (FacilityEnum)	*
facilities[][id]	integer	*
facilities[][uid]	string	*	OPAN UID of the Facility.
facilities[][name]	string	*

Status Codes

Status Code	Description
200	On success
401	If ApiKey is unrecognized or ApiUser is disabled

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

medics

/api/nursinghome/v2/medics

GET /api/nursinghome/v2/medics

Get medics

Documentation
Sandbox

Documentation

Get list of medics. Has to be filtered by a search string that tries to match all relevant fields such as name, address, etc. in an intelligent fulltext search, e.g. "Hans Müller Bern"

Filters

Name

Information

Datatype

string

Return

Parameter	Type	Versions	Description
200 - On success
medics[]	array of objects (Medic)	*
medics[][address]	object (Address)	*
medics[][address][street]	string	*
medics[][address][houseNumber]	string	*
medics[][address][addressSupplement]	string	*
medics[][address][zip]	integer	*	The postal code of the town or village
medics[][address][location]	string	*	The town or village name
medics[][firstName]	string	*
medics[][lastName]	string	*
medics[][zsr]	string	*

Status Codes

Status Code	Description
200	On success
401	If ApiKey is unrecognized or ApiUser is disabled

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/medics/{zsr}

Get details of medic

Documentation
Sandbox

Documentation

Get details of a specific medic

Requirements

Name	Requirement	Type	Description
zsr	\d+	integer	Medic's ZSR number

Return

Parameter	Type	Versions	Description
200 - On success
address	object (Address)	*
address[street]	string	*
address[houseNumber]	string	*
address[addressSupplement]	string	*
address[zip]	integer	*	The postal code of the town or village
address[location]	string	*	The town or village name
firstName	string	*
lastName	string	*
gln	string	*
zsr	string	*
title	integer	*	Enumeration: 1=Dr. med., 2=PD Dr. med., 3=Med. pract., 4=Dr. med. dent., 5=Med. dent., 6=Prof. Dr. med., 7=Dr., 8=Prof. Dr. med. dent., 9=PD Dr. med. dent., 10=Prof. Dr., 11=Dres.
gender	integer	*	Enumeration: 1=male, 2=female
phone1	string	*
phone2	string	*
email	string	*

Status Codes

Status Code	Description
200	On success
401	If ApiKey is unrecognized or ApiUser is disabled
404	If no medic with specified zsr number was found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Easy API usage with Postman:

applications

/api/nursinghome/v2/applications

GET /api/nursinghome/v2/applications

Documentation

Parameters

Return

200 - On success

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/applications/institution/{hash}

Documentation

Requirements

Return

200 - On success

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/applications/medic/{hash}

Documentation

Requirements

Return

200 - On success

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/applications/private/{hash}

Documentation

Requirements

Return

200 - On success

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/nursinghome/v2/applications/{hash}

Documentation

Requirements

Parameters

Headers

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/nursinghome/v2/applications/{hash}/pdf

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

document transfers

/api/nursinghome/v2/documenttransfers

GET /api/nursinghome/v2/documenttransfers

Documentation

Parameters

Return