Community Mental Health Bundle
API change historyRetrieve Community Mental Health Data
Request
Request URL
Request parameters
-
string
-
(optional)integer
The maximum number of past results to return.
-
(optional)integer
The maximum number of future results to return.
Request headers
-
stringOAuth 2.0 access token obtained from CareCentric System Authorisation. Supported grant types: Client credentials.
Request body
Responses
200 OK
Successful operation
Representations
{
"Summary": {
"Referrals": {
"ReferredSpecialties": "string",
"OpenReferralCount": 0,
"DischargeReferralCount": 0,
"TenancyDescription": "string"
},
"Inpatient": {
"Status": {
"LeaveOfAbsence": true,
"CurrentInpatient": true
},
"AdmissionCount6Month": 0,
"TotalAdmissionCount": 0,
"LatestInpatientDetails": {
"LeaveofAbsence": true,
"AdmissionDate": "string",
"DischargeDate": "string",
"Location": "string",
"ClinicianName": "string",
"Specialty": "string",
"DecisionToAdmit": "string",
"AdmissionMethod": "string",
"AdmissionSource": "string",
"SourceOfReferral": "string",
"ReferralDate": "string",
"IntendedManagement": "string",
"PsychiatricAdmissionStatus": "string",
"AdmissionLegalStatus": "string",
"CensusLegalStatus": "string",
"MentalCategory": "string",
"TenancyDescription": "string",
"BedLocation": "string"
}
},
"Outpatient": {
"FutureAppointmentCount": 0,
"PastAppointmentCount": 0,
"LatestOutpatientAppointmentDetails": {
"AttendanceDate": "string",
"LocationType": "string",
"AppointmentType": "string",
"ClinicianName": "string",
"AttendanceOutcome": "string",
"AttendedOrDna": "string",
"TenancyDescription": "string"
}
}
},
"Detail": {
"OpenReferrals": [
{
"ReferralSourceDescription": "string",
"Referrer": "string",
"ContactNumber": "string",
"ReferralDate": "string",
"UrgencyDescription": "string",
"ReferralReason": "string",
"TeamReferredTo": "string",
"HCPReferredTo": "string",
"SpecialtyDescription": "string",
"DateReceived": "string",
"CareSetting": "string",
"DateAccepted": "string",
"TenancyDescription": "string"
}
],
"DischargedReferrals": [
{
"DischargeDate": "string",
"DischargeHCP": "string",
"DischargeReason": "string",
"ReferralSourceDescription": "string",
"Referrer": "string",
"ContactNumber": "string",
"ReferralDate": "string",
"UrgencyDescription": "string",
"ReferralReason": "string",
"TeamReferredTo": "string",
"HCPReferredTo": "string",
"SpecialtyDescription": "string",
"DateReceived": "string",
"CareSetting": "string",
"DateAccepted": "string",
"TenancyDescription": "string"
}
],
"InpatientActivity": [
{
"LeaveofAbsence": true,
"AdmissionDate": "string",
"DischargeDate": "string",
"Location": "string",
"ClinicianName": "string",
"Specialty": "string",
"DecisionToAdmit": "string",
"AdmissionMethod": "string",
"AdmissionSource": "string",
"SourceOfReferral": "string",
"ReferralDate": "string",
"IntendedManagement": "string",
"PsychiatricAdmissionStatus": "string",
"AdmissionLegalStatus": "string",
"CensusLegalStatus": "string",
"MentalCategory": "string",
"TenancyDescription": "string",
"BedLocation": "string"
}
],
"FutureOutpatientActivity": [
{
"AttendanceDate": "string",
"LocationType": "string",
"AppointmentType": "string",
"ClinicianName": "string",
"AttendanceOutcome": "string",
"AttendedOrDna": "string",
"TenancyDescription": "string"
}
],
"PastOutpatientActivity": [
{
"AttendanceDate": "string",
"LocationType": "string",
"AppointmentType": "string",
"ClinicianName": "string",
"AttendanceOutcome": "string",
"AttendedOrDna": "string",
"TenancyDescription": "string"
}
]
}
}{
"description": "The store patient alert response.",
"type": "object",
"properties": {
"Summary": {
"description": "Gets or sets the summary.",
"type": "object",
"properties": {
"Referrals": {
"description": "Gets or sets the referrals.",
"type": "object",
"properties": {
"ReferredSpecialties": {
"description": "Referred Specialties.",
"type": "string"
},
"OpenReferralCount": {
"format": "int32",
"description": "Open Referral Count.",
"type": "integer"
},
"DischargeReferralCount": {
"format": "int32",
"description": "Discharge Referral Count.",
"type": "integer"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
},
"Inpatient": {
"description": "Gets or sets the inpatient.",
"type": "object",
"properties": {
"Status": {
"description": "Inpatient Status.",
"type": "object",
"properties": {
"LeaveOfAbsence": {
"description": "Leave Of Absence.",
"type": "boolean"
},
"CurrentInpatient": {
"description": "Current Inpatient.",
"type": "boolean"
}
}
},
"AdmissionCount6Month": {
"format": "int32",
"description": "Admission Count in last 6 Month.",
"type": "integer"
},
"TotalAdmissionCount": {
"format": "int32",
"description": "Total Admission Count.",
"type": "integer"
},
"LatestInpatientDetails": {
"description": "Latest Inpatient Details.",
"type": "object",
"properties": {
"LeaveofAbsence": {
"description": "Gets or sets a value indicating whether [leaveof absence].",
"type": "boolean"
},
"AdmissionDate": {
"format": "date-time",
"description": "Gets or sets the admission date.",
"type": "string"
},
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"Location": {
"description": "Gets or sets the location.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"Specialty": {
"description": "Gets or sets the specialty.",
"type": "string"
},
"DecisionToAdmit": {
"format": "date-time",
"description": "Gets or sets the decision to admit.",
"type": "string"
},
"AdmissionMethod": {
"description": "Gets or sets the admission method.",
"type": "string"
},
"AdmissionSource": {
"description": "Gets or sets the admission source.",
"type": "string"
},
"SourceOfReferral": {
"description": "Gets or sets the source of referral.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"IntendedManagement": {
"description": "Gets or sets the intended management.",
"type": "string"
},
"PsychiatricAdmissionStatus": {
"description": "Gets or sets the psychiatric admission status.",
"type": "string"
},
"AdmissionLegalStatus": {
"description": "Gets or sets the admission legal status.",
"type": "string"
},
"CensusLegalStatus": {
"description": "Gets or sets the census legal status.",
"type": "string"
},
"MentalCategory": {
"description": "Gets or sets the mental category.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
},
"BedLocation": {
"description": "Bed Location.",
"type": "string"
}
}
}
}
},
"Outpatient": {
"description": "Gets or sets the outpatient.",
"type": "object",
"properties": {
"FutureAppointmentCount": {
"format": "int32",
"description": "Future Appointment Count.",
"type": "integer"
},
"PastAppointmentCount": {
"format": "int32",
"description": "Past Appointment Count.",
"type": "integer"
},
"LatestOutpatientAppointmentDetails": {
"description": "Latest Outpatient Appointment Details.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
}
}
}
},
"Detail": {
"description": "Gets or sets the detail.",
"type": "object",
"properties": {
"OpenReferrals": {
"description": "Open Referrals collection.",
"type": "array",
"items": {
"description": "The referral.",
"type": "object",
"properties": {
"ReferralSourceDescription": {
"description": "Gets or sets the referral source description.",
"type": "string"
},
"Referrer": {
"description": "Gets or sets the referrer.",
"type": "string"
},
"ContactNumber": {
"description": "Gets or sets the contact number.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"UrgencyDescription": {
"description": "Gets or sets the urgency description.",
"type": "string"
},
"ReferralReason": {
"description": "Gets or sets the referral reason.",
"type": "string"
},
"TeamReferredTo": {
"description": "Gets or sets the team referred to.",
"type": "string"
},
"HCPReferredTo": {
"description": "Gets or sets the HCP referred to.",
"type": "string"
},
"SpecialtyDescription": {
"description": "Gets or sets the specialty description.",
"type": "string"
},
"DateReceived": {
"format": "date-time",
"description": "Gets or sets the date received.",
"type": "string"
},
"CareSetting": {
"description": "Gets or sets the care setting.",
"type": "string"
},
"DateAccepted": {
"format": "date-time",
"description": "Gets or sets the date accepted.",
"type": "string"
},
"TenancyDescription": {
"description": "Gets or sets the tenancy description.",
"type": "string"
}
}
}
},
"DischargedReferrals": {
"description": "Discharged Referrals collection.",
"type": "array",
"items": {
"description": "The discharged referral.",
"type": "object",
"properties": {
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"DischargeHCP": {
"description": "Gets or sets the discharge HCP.",
"type": "string"
},
"DischargeReason": {
"description": "Gets or sets the discharge reason.",
"type": "string"
},
"ReferralSourceDescription": {
"description": "Gets or sets the referral source description.",
"type": "string"
},
"Referrer": {
"description": "Gets or sets the referrer.",
"type": "string"
},
"ContactNumber": {
"description": "Gets or sets the contact number.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"UrgencyDescription": {
"description": "Gets or sets the urgency description.",
"type": "string"
},
"ReferralReason": {
"description": "Gets or sets the referral reason.",
"type": "string"
},
"TeamReferredTo": {
"description": "Gets or sets the team referred to.",
"type": "string"
},
"HCPReferredTo": {
"description": "Gets or sets the HCP referred to.",
"type": "string"
},
"SpecialtyDescription": {
"description": "Gets or sets the specialty description.",
"type": "string"
},
"DateReceived": {
"format": "date-time",
"description": "Gets or sets the date received.",
"type": "string"
},
"CareSetting": {
"description": "Gets or sets the care setting.",
"type": "string"
},
"DateAccepted": {
"format": "date-time",
"description": "Gets or sets the date accepted.",
"type": "string"
},
"TenancyDescription": {
"description": "Gets or sets the tenancy description.",
"type": "string"
}
}
}
},
"InpatientActivity": {
"description": "Inpatient Activity collection.",
"type": "array",
"items": {
"description": "The inpatient.",
"type": "object",
"properties": {
"LeaveofAbsence": {
"description": "Gets or sets a value indicating whether [leaveof absence].",
"type": "boolean"
},
"AdmissionDate": {
"format": "date-time",
"description": "Gets or sets the admission date.",
"type": "string"
},
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"Location": {
"description": "Gets or sets the location.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"Specialty": {
"description": "Gets or sets the specialty.",
"type": "string"
},
"DecisionToAdmit": {
"format": "date-time",
"description": "Gets or sets the decision to admit.",
"type": "string"
},
"AdmissionMethod": {
"description": "Gets or sets the admission method.",
"type": "string"
},
"AdmissionSource": {
"description": "Gets or sets the admission source.",
"type": "string"
},
"SourceOfReferral": {
"description": "Gets or sets the source of referral.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"IntendedManagement": {
"description": "Gets or sets the intended management.",
"type": "string"
},
"PsychiatricAdmissionStatus": {
"description": "Gets or sets the psychiatric admission status.",
"type": "string"
},
"AdmissionLegalStatus": {
"description": "Gets or sets the admission legal status.",
"type": "string"
},
"CensusLegalStatus": {
"description": "Gets or sets the census legal status.",
"type": "string"
},
"MentalCategory": {
"description": "Gets or sets the mental category.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
},
"BedLocation": {
"description": "Bed Location.",
"type": "string"
}
}
}
},
"FutureOutpatientActivity": {
"description": "Future Outpatient Activity Collection.",
"type": "array",
"items": {
"description": "The outpatient.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
},
"PastOutpatientActivity": {
"description": "Past Outpatient Activity Collection.",
"type": "array",
"items": {
"description": "The outpatient.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
}
}
}
}
}{
"Summary": {
"Referrals": {
"ReferredSpecialties": "string",
"OpenReferralCount": 0,
"DischargeReferralCount": 0,
"TenancyDescription": "string"
},
"Inpatient": {
"Status": {
"LeaveOfAbsence": true,
"CurrentInpatient": true
},
"AdmissionCount6Month": 0,
"TotalAdmissionCount": 0,
"LatestInpatientDetails": {
"LeaveofAbsence": true,
"AdmissionDate": "string",
"DischargeDate": "string",
"Location": "string",
"ClinicianName": "string",
"Specialty": "string",
"DecisionToAdmit": "string",
"AdmissionMethod": "string",
"AdmissionSource": "string",
"SourceOfReferral": "string",
"ReferralDate": "string",
"IntendedManagement": "string",
"PsychiatricAdmissionStatus": "string",
"AdmissionLegalStatus": "string",
"CensusLegalStatus": "string",
"MentalCategory": "string",
"TenancyDescription": "string",
"BedLocation": "string"
}
},
"Outpatient": {
"FutureAppointmentCount": 0,
"PastAppointmentCount": 0,
"LatestOutpatientAppointmentDetails": {
"AttendanceDate": "string",
"LocationType": "string",
"AppointmentType": "string",
"ClinicianName": "string",
"AttendanceOutcome": "string",
"AttendedOrDna": "string",
"TenancyDescription": "string"
}
}
},
"Detail": {
"OpenReferrals": [
{
"ReferralSourceDescription": "string",
"Referrer": "string",
"ContactNumber": "string",
"ReferralDate": "string",
"UrgencyDescription": "string",
"ReferralReason": "string",
"TeamReferredTo": "string",
"HCPReferredTo": "string",
"SpecialtyDescription": "string",
"DateReceived": "string",
"CareSetting": "string",
"DateAccepted": "string",
"TenancyDescription": "string"
}
],
"DischargedReferrals": [
{
"DischargeDate": "string",
"DischargeHCP": "string",
"DischargeReason": "string",
"ReferralSourceDescription": "string",
"Referrer": "string",
"ContactNumber": "string",
"ReferralDate": "string",
"UrgencyDescription": "string",
"ReferralReason": "string",
"TeamReferredTo": "string",
"HCPReferredTo": "string",
"SpecialtyDescription": "string",
"DateReceived": "string",
"CareSetting": "string",
"DateAccepted": "string",
"TenancyDescription": "string"
}
],
"InpatientActivity": [
{
"LeaveofAbsence": true,
"AdmissionDate": "string",
"DischargeDate": "string",
"Location": "string",
"ClinicianName": "string",
"Specialty": "string",
"DecisionToAdmit": "string",
"AdmissionMethod": "string",
"AdmissionSource": "string",
"SourceOfReferral": "string",
"ReferralDate": "string",
"IntendedManagement": "string",
"PsychiatricAdmissionStatus": "string",
"AdmissionLegalStatus": "string",
"CensusLegalStatus": "string",
"MentalCategory": "string",
"TenancyDescription": "string",
"BedLocation": "string"
}
],
"FutureOutpatientActivity": [
{
"AttendanceDate": "string",
"LocationType": "string",
"AppointmentType": "string",
"ClinicianName": "string",
"AttendanceOutcome": "string",
"AttendedOrDna": "string",
"TenancyDescription": "string"
}
],
"PastOutpatientActivity": [
{
"AttendanceDate": "string",
"LocationType": "string",
"AppointmentType": "string",
"ClinicianName": "string",
"AttendanceOutcome": "string",
"AttendedOrDna": "string",
"TenancyDescription": "string"
}
]
}
}{
"description": "The store patient alert response.",
"type": "object",
"properties": {
"Summary": {
"description": "Gets or sets the summary.",
"type": "object",
"properties": {
"Referrals": {
"description": "Gets or sets the referrals.",
"type": "object",
"properties": {
"ReferredSpecialties": {
"description": "Referred Specialties.",
"type": "string"
},
"OpenReferralCount": {
"format": "int32",
"description": "Open Referral Count.",
"type": "integer"
},
"DischargeReferralCount": {
"format": "int32",
"description": "Discharge Referral Count.",
"type": "integer"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
},
"Inpatient": {
"description": "Gets or sets the inpatient.",
"type": "object",
"properties": {
"Status": {
"description": "Inpatient Status.",
"type": "object",
"properties": {
"LeaveOfAbsence": {
"description": "Leave Of Absence.",
"type": "boolean"
},
"CurrentInpatient": {
"description": "Current Inpatient.",
"type": "boolean"
}
}
},
"AdmissionCount6Month": {
"format": "int32",
"description": "Admission Count in last 6 Month.",
"type": "integer"
},
"TotalAdmissionCount": {
"format": "int32",
"description": "Total Admission Count.",
"type": "integer"
},
"LatestInpatientDetails": {
"description": "Latest Inpatient Details.",
"type": "object",
"properties": {
"LeaveofAbsence": {
"description": "Gets or sets a value indicating whether [leaveof absence].",
"type": "boolean"
},
"AdmissionDate": {
"format": "date-time",
"description": "Gets or sets the admission date.",
"type": "string"
},
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"Location": {
"description": "Gets or sets the location.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"Specialty": {
"description": "Gets or sets the specialty.",
"type": "string"
},
"DecisionToAdmit": {
"format": "date-time",
"description": "Gets or sets the decision to admit.",
"type": "string"
},
"AdmissionMethod": {
"description": "Gets or sets the admission method.",
"type": "string"
},
"AdmissionSource": {
"description": "Gets or sets the admission source.",
"type": "string"
},
"SourceOfReferral": {
"description": "Gets or sets the source of referral.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"IntendedManagement": {
"description": "Gets or sets the intended management.",
"type": "string"
},
"PsychiatricAdmissionStatus": {
"description": "Gets or sets the psychiatric admission status.",
"type": "string"
},
"AdmissionLegalStatus": {
"description": "Gets or sets the admission legal status.",
"type": "string"
},
"CensusLegalStatus": {
"description": "Gets or sets the census legal status.",
"type": "string"
},
"MentalCategory": {
"description": "Gets or sets the mental category.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
},
"BedLocation": {
"description": "Bed Location.",
"type": "string"
}
}
}
}
},
"Outpatient": {
"description": "Gets or sets the outpatient.",
"type": "object",
"properties": {
"FutureAppointmentCount": {
"format": "int32",
"description": "Future Appointment Count.",
"type": "integer"
},
"PastAppointmentCount": {
"format": "int32",
"description": "Past Appointment Count.",
"type": "integer"
},
"LatestOutpatientAppointmentDetails": {
"description": "Latest Outpatient Appointment Details.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
}
}
}
},
"Detail": {
"description": "Gets or sets the detail.",
"type": "object",
"properties": {
"OpenReferrals": {
"description": "Open Referrals collection.",
"type": "array",
"items": {
"description": "The referral.",
"type": "object",
"properties": {
"ReferralSourceDescription": {
"description": "Gets or sets the referral source description.",
"type": "string"
},
"Referrer": {
"description": "Gets or sets the referrer.",
"type": "string"
},
"ContactNumber": {
"description": "Gets or sets the contact number.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"UrgencyDescription": {
"description": "Gets or sets the urgency description.",
"type": "string"
},
"ReferralReason": {
"description": "Gets or sets the referral reason.",
"type": "string"
},
"TeamReferredTo": {
"description": "Gets or sets the team referred to.",
"type": "string"
},
"HCPReferredTo": {
"description": "Gets or sets the HCP referred to.",
"type": "string"
},
"SpecialtyDescription": {
"description": "Gets or sets the specialty description.",
"type": "string"
},
"DateReceived": {
"format": "date-time",
"description": "Gets or sets the date received.",
"type": "string"
},
"CareSetting": {
"description": "Gets or sets the care setting.",
"type": "string"
},
"DateAccepted": {
"format": "date-time",
"description": "Gets or sets the date accepted.",
"type": "string"
},
"TenancyDescription": {
"description": "Gets or sets the tenancy description.",
"type": "string"
}
}
}
},
"DischargedReferrals": {
"description": "Discharged Referrals collection.",
"type": "array",
"items": {
"description": "The discharged referral.",
"type": "object",
"properties": {
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"DischargeHCP": {
"description": "Gets or sets the discharge HCP.",
"type": "string"
},
"DischargeReason": {
"description": "Gets or sets the discharge reason.",
"type": "string"
},
"ReferralSourceDescription": {
"description": "Gets or sets the referral source description.",
"type": "string"
},
"Referrer": {
"description": "Gets or sets the referrer.",
"type": "string"
},
"ContactNumber": {
"description": "Gets or sets the contact number.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"UrgencyDescription": {
"description": "Gets or sets the urgency description.",
"type": "string"
},
"ReferralReason": {
"description": "Gets or sets the referral reason.",
"type": "string"
},
"TeamReferredTo": {
"description": "Gets or sets the team referred to.",
"type": "string"
},
"HCPReferredTo": {
"description": "Gets or sets the HCP referred to.",
"type": "string"
},
"SpecialtyDescription": {
"description": "Gets or sets the specialty description.",
"type": "string"
},
"DateReceived": {
"format": "date-time",
"description": "Gets or sets the date received.",
"type": "string"
},
"CareSetting": {
"description": "Gets or sets the care setting.",
"type": "string"
},
"DateAccepted": {
"format": "date-time",
"description": "Gets or sets the date accepted.",
"type": "string"
},
"TenancyDescription": {
"description": "Gets or sets the tenancy description.",
"type": "string"
}
}
}
},
"InpatientActivity": {
"description": "Inpatient Activity collection.",
"type": "array",
"items": {
"description": "The inpatient.",
"type": "object",
"properties": {
"LeaveofAbsence": {
"description": "Gets or sets a value indicating whether [leaveof absence].",
"type": "boolean"
},
"AdmissionDate": {
"format": "date-time",
"description": "Gets or sets the admission date.",
"type": "string"
},
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"Location": {
"description": "Gets or sets the location.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"Specialty": {
"description": "Gets or sets the specialty.",
"type": "string"
},
"DecisionToAdmit": {
"format": "date-time",
"description": "Gets or sets the decision to admit.",
"type": "string"
},
"AdmissionMethod": {
"description": "Gets or sets the admission method.",
"type": "string"
},
"AdmissionSource": {
"description": "Gets or sets the admission source.",
"type": "string"
},
"SourceOfReferral": {
"description": "Gets or sets the source of referral.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"IntendedManagement": {
"description": "Gets or sets the intended management.",
"type": "string"
},
"PsychiatricAdmissionStatus": {
"description": "Gets or sets the psychiatric admission status.",
"type": "string"
},
"AdmissionLegalStatus": {
"description": "Gets or sets the admission legal status.",
"type": "string"
},
"CensusLegalStatus": {
"description": "Gets or sets the census legal status.",
"type": "string"
},
"MentalCategory": {
"description": "Gets or sets the mental category.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
},
"BedLocation": {
"description": "Bed Location.",
"type": "string"
}
}
}
},
"FutureOutpatientActivity": {
"description": "Future Outpatient Activity Collection.",
"type": "array",
"items": {
"description": "The outpatient.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
},
"PastOutpatientActivity": {
"description": "Past Outpatient Activity Collection.",
"type": "array",
"items": {
"description": "The outpatient.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
}
}
}
}
}<RIOCommunity.Models.CommunityMentalHealthActivity.Response>
<Summary>
<Referrals>
<ReferredSpecialties>string</ReferredSpecialties>
<OpenReferralCount>0</OpenReferralCount>
<DischargeReferralCount>0</DischargeReferralCount>
<TenancyDescription>string</TenancyDescription>
</Referrals>
<Inpatient>
<Status>
<LeaveOfAbsence>true</LeaveOfAbsence>
<CurrentInpatient>true</CurrentInpatient>
</Status>
<AdmissionCount6Month>0</AdmissionCount6Month>
<TotalAdmissionCount>0</TotalAdmissionCount>
<LatestInpatientDetails>
<LeaveofAbsence>true</LeaveofAbsence>
<AdmissionDate>string</AdmissionDate>
<DischargeDate>string</DischargeDate>
<Location>string</Location>
<ClinicianName>string</ClinicianName>
<Specialty>string</Specialty>
<DecisionToAdmit>string</DecisionToAdmit>
<AdmissionMethod>string</AdmissionMethod>
<AdmissionSource>string</AdmissionSource>
<SourceOfReferral>string</SourceOfReferral>
<ReferralDate>string</ReferralDate>
<IntendedManagement>string</IntendedManagement>
<PsychiatricAdmissionStatus>string</PsychiatricAdmissionStatus>
<AdmissionLegalStatus>string</AdmissionLegalStatus>
<CensusLegalStatus>string</CensusLegalStatus>
<MentalCategory>string</MentalCategory>
<TenancyDescription>string</TenancyDescription>
<BedLocation>string</BedLocation>
</LatestInpatientDetails>
</Inpatient>
<Outpatient>
<FutureAppointmentCount>0</FutureAppointmentCount>
<PastAppointmentCount>0</PastAppointmentCount>
<LatestOutpatientAppointmentDetails>
<AttendanceDate>string</AttendanceDate>
<LocationType>string</LocationType>
<AppointmentType>string</AppointmentType>
<ClinicianName>string</ClinicianName>
<AttendanceOutcome>string</AttendanceOutcome>
<AttendedOrDna>string</AttendedOrDna>
<TenancyDescription>string</TenancyDescription>
</LatestOutpatientAppointmentDetails>
</Outpatient>
</Summary>
<Detail>
<OpenReferrals>
<ReferralSourceDescription>string</ReferralSourceDescription>
<Referrer>string</Referrer>
<ContactNumber>string</ContactNumber>
<ReferralDate>string</ReferralDate>
<UrgencyDescription>string</UrgencyDescription>
<ReferralReason>string</ReferralReason>
<TeamReferredTo>string</TeamReferredTo>
<HCPReferredTo>string</HCPReferredTo>
<SpecialtyDescription>string</SpecialtyDescription>
<DateReceived>string</DateReceived>
<CareSetting>string</CareSetting>
<DateAccepted>string</DateAccepted>
<TenancyDescription>string</TenancyDescription>
</OpenReferrals>
<DischargedReferrals>
<DischargeDate>string</DischargeDate>
<DischargeHCP>string</DischargeHCP>
<DischargeReason>string</DischargeReason>
<ReferralSourceDescription>string</ReferralSourceDescription>
<Referrer>string</Referrer>
<ContactNumber>string</ContactNumber>
<ReferralDate>string</ReferralDate>
<UrgencyDescription>string</UrgencyDescription>
<ReferralReason>string</ReferralReason>
<TeamReferredTo>string</TeamReferredTo>
<HCPReferredTo>string</HCPReferredTo>
<SpecialtyDescription>string</SpecialtyDescription>
<DateReceived>string</DateReceived>
<CareSetting>string</CareSetting>
<DateAccepted>string</DateAccepted>
<TenancyDescription>string</TenancyDescription>
</DischargedReferrals>
<InpatientActivity>
<LeaveofAbsence>true</LeaveofAbsence>
<AdmissionDate>string</AdmissionDate>
<DischargeDate>string</DischargeDate>
<Location>string</Location>
<ClinicianName>string</ClinicianName>
<Specialty>string</Specialty>
<DecisionToAdmit>string</DecisionToAdmit>
<AdmissionMethod>string</AdmissionMethod>
<AdmissionSource>string</AdmissionSource>
<SourceOfReferral>string</SourceOfReferral>
<ReferralDate>string</ReferralDate>
<IntendedManagement>string</IntendedManagement>
<PsychiatricAdmissionStatus>string</PsychiatricAdmissionStatus>
<AdmissionLegalStatus>string</AdmissionLegalStatus>
<CensusLegalStatus>string</CensusLegalStatus>
<MentalCategory>string</MentalCategory>
<TenancyDescription>string</TenancyDescription>
<BedLocation>string</BedLocation>
</InpatientActivity>
<FutureOutpatientActivity>
<AttendanceDate>string</AttendanceDate>
<LocationType>string</LocationType>
<AppointmentType>string</AppointmentType>
<ClinicianName>string</ClinicianName>
<AttendanceOutcome>string</AttendanceOutcome>
<AttendedOrDna>string</AttendedOrDna>
<TenancyDescription>string</TenancyDescription>
</FutureOutpatientActivity>
<PastOutpatientActivity>
<AttendanceDate>string</AttendanceDate>
<LocationType>string</LocationType>
<AppointmentType>string</AppointmentType>
<ClinicianName>string</ClinicianName>
<AttendanceOutcome>string</AttendanceOutcome>
<AttendedOrDna>string</AttendedOrDna>
<TenancyDescription>string</TenancyDescription>
</PastOutpatientActivity>
</Detail>
</RIOCommunity.Models.CommunityMentalHealthActivity.Response>{
"description": "The store patient alert response.",
"type": "object",
"properties": {
"Summary": {
"description": "Gets or sets the summary.",
"type": "object",
"properties": {
"Referrals": {
"description": "Gets or sets the referrals.",
"type": "object",
"properties": {
"ReferredSpecialties": {
"description": "Referred Specialties.",
"type": "string"
},
"OpenReferralCount": {
"format": "int32",
"description": "Open Referral Count.",
"type": "integer"
},
"DischargeReferralCount": {
"format": "int32",
"description": "Discharge Referral Count.",
"type": "integer"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
},
"Inpatient": {
"description": "Gets or sets the inpatient.",
"type": "object",
"properties": {
"Status": {
"description": "Inpatient Status.",
"type": "object",
"properties": {
"LeaveOfAbsence": {
"description": "Leave Of Absence.",
"type": "boolean"
},
"CurrentInpatient": {
"description": "Current Inpatient.",
"type": "boolean"
}
}
},
"AdmissionCount6Month": {
"format": "int32",
"description": "Admission Count in last 6 Month.",
"type": "integer"
},
"TotalAdmissionCount": {
"format": "int32",
"description": "Total Admission Count.",
"type": "integer"
},
"LatestInpatientDetails": {
"description": "Latest Inpatient Details.",
"type": "object",
"properties": {
"LeaveofAbsence": {
"description": "Gets or sets a value indicating whether [leaveof absence].",
"type": "boolean"
},
"AdmissionDate": {
"format": "date-time",
"description": "Gets or sets the admission date.",
"type": "string"
},
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"Location": {
"description": "Gets or sets the location.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"Specialty": {
"description": "Gets or sets the specialty.",
"type": "string"
},
"DecisionToAdmit": {
"format": "date-time",
"description": "Gets or sets the decision to admit.",
"type": "string"
},
"AdmissionMethod": {
"description": "Gets or sets the admission method.",
"type": "string"
},
"AdmissionSource": {
"description": "Gets or sets the admission source.",
"type": "string"
},
"SourceOfReferral": {
"description": "Gets or sets the source of referral.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"IntendedManagement": {
"description": "Gets or sets the intended management.",
"type": "string"
},
"PsychiatricAdmissionStatus": {
"description": "Gets or sets the psychiatric admission status.",
"type": "string"
},
"AdmissionLegalStatus": {
"description": "Gets or sets the admission legal status.",
"type": "string"
},
"CensusLegalStatus": {
"description": "Gets or sets the census legal status.",
"type": "string"
},
"MentalCategory": {
"description": "Gets or sets the mental category.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
},
"BedLocation": {
"description": "Bed Location.",
"type": "string"
}
}
}
}
},
"Outpatient": {
"description": "Gets or sets the outpatient.",
"type": "object",
"properties": {
"FutureAppointmentCount": {
"format": "int32",
"description": "Future Appointment Count.",
"type": "integer"
},
"PastAppointmentCount": {
"format": "int32",
"description": "Past Appointment Count.",
"type": "integer"
},
"LatestOutpatientAppointmentDetails": {
"description": "Latest Outpatient Appointment Details.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
}
}
}
},
"Detail": {
"description": "Gets or sets the detail.",
"type": "object",
"properties": {
"OpenReferrals": {
"description": "Open Referrals collection.",
"type": "array",
"items": {
"description": "The referral.",
"type": "object",
"properties": {
"ReferralSourceDescription": {
"description": "Gets or sets the referral source description.",
"type": "string"
},
"Referrer": {
"description": "Gets or sets the referrer.",
"type": "string"
},
"ContactNumber": {
"description": "Gets or sets the contact number.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"UrgencyDescription": {
"description": "Gets or sets the urgency description.",
"type": "string"
},
"ReferralReason": {
"description": "Gets or sets the referral reason.",
"type": "string"
},
"TeamReferredTo": {
"description": "Gets or sets the team referred to.",
"type": "string"
},
"HCPReferredTo": {
"description": "Gets or sets the HCP referred to.",
"type": "string"
},
"SpecialtyDescription": {
"description": "Gets or sets the specialty description.",
"type": "string"
},
"DateReceived": {
"format": "date-time",
"description": "Gets or sets the date received.",
"type": "string"
},
"CareSetting": {
"description": "Gets or sets the care setting.",
"type": "string"
},
"DateAccepted": {
"format": "date-time",
"description": "Gets or sets the date accepted.",
"type": "string"
},
"TenancyDescription": {
"description": "Gets or sets the tenancy description.",
"type": "string"
}
}
}
},
"DischargedReferrals": {
"description": "Discharged Referrals collection.",
"type": "array",
"items": {
"description": "The discharged referral.",
"type": "object",
"properties": {
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"DischargeHCP": {
"description": "Gets or sets the discharge HCP.",
"type": "string"
},
"DischargeReason": {
"description": "Gets or sets the discharge reason.",
"type": "string"
},
"ReferralSourceDescription": {
"description": "Gets or sets the referral source description.",
"type": "string"
},
"Referrer": {
"description": "Gets or sets the referrer.",
"type": "string"
},
"ContactNumber": {
"description": "Gets or sets the contact number.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"UrgencyDescription": {
"description": "Gets or sets the urgency description.",
"type": "string"
},
"ReferralReason": {
"description": "Gets or sets the referral reason.",
"type": "string"
},
"TeamReferredTo": {
"description": "Gets or sets the team referred to.",
"type": "string"
},
"HCPReferredTo": {
"description": "Gets or sets the HCP referred to.",
"type": "string"
},
"SpecialtyDescription": {
"description": "Gets or sets the specialty description.",
"type": "string"
},
"DateReceived": {
"format": "date-time",
"description": "Gets or sets the date received.",
"type": "string"
},
"CareSetting": {
"description": "Gets or sets the care setting.",
"type": "string"
},
"DateAccepted": {
"format": "date-time",
"description": "Gets or sets the date accepted.",
"type": "string"
},
"TenancyDescription": {
"description": "Gets or sets the tenancy description.",
"type": "string"
}
}
}
},
"InpatientActivity": {
"description": "Inpatient Activity collection.",
"type": "array",
"items": {
"description": "The inpatient.",
"type": "object",
"properties": {
"LeaveofAbsence": {
"description": "Gets or sets a value indicating whether [leaveof absence].",
"type": "boolean"
},
"AdmissionDate": {
"format": "date-time",
"description": "Gets or sets the admission date.",
"type": "string"
},
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"Location": {
"description": "Gets or sets the location.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"Specialty": {
"description": "Gets or sets the specialty.",
"type": "string"
},
"DecisionToAdmit": {
"format": "date-time",
"description": "Gets or sets the decision to admit.",
"type": "string"
},
"AdmissionMethod": {
"description": "Gets or sets the admission method.",
"type": "string"
},
"AdmissionSource": {
"description": "Gets or sets the admission source.",
"type": "string"
},
"SourceOfReferral": {
"description": "Gets or sets the source of referral.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"IntendedManagement": {
"description": "Gets or sets the intended management.",
"type": "string"
},
"PsychiatricAdmissionStatus": {
"description": "Gets or sets the psychiatric admission status.",
"type": "string"
},
"AdmissionLegalStatus": {
"description": "Gets or sets the admission legal status.",
"type": "string"
},
"CensusLegalStatus": {
"description": "Gets or sets the census legal status.",
"type": "string"
},
"MentalCategory": {
"description": "Gets or sets the mental category.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
},
"BedLocation": {
"description": "Bed Location.",
"type": "string"
}
}
}
},
"FutureOutpatientActivity": {
"description": "Future Outpatient Activity Collection.",
"type": "array",
"items": {
"description": "The outpatient.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
},
"PastOutpatientActivity": {
"description": "Past Outpatient Activity Collection.",
"type": "array",
"items": {
"description": "The outpatient.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
}
}
}
}
}<RIOCommunity.Models.CommunityMentalHealthActivity.Response>
<Summary>
<Referrals>
<ReferredSpecialties>string</ReferredSpecialties>
<OpenReferralCount>0</OpenReferralCount>
<DischargeReferralCount>0</DischargeReferralCount>
<TenancyDescription>string</TenancyDescription>
</Referrals>
<Inpatient>
<Status>
<LeaveOfAbsence>true</LeaveOfAbsence>
<CurrentInpatient>true</CurrentInpatient>
</Status>
<AdmissionCount6Month>0</AdmissionCount6Month>
<TotalAdmissionCount>0</TotalAdmissionCount>
<LatestInpatientDetails>
<LeaveofAbsence>true</LeaveofAbsence>
<AdmissionDate>string</AdmissionDate>
<DischargeDate>string</DischargeDate>
<Location>string</Location>
<ClinicianName>string</ClinicianName>
<Specialty>string</Specialty>
<DecisionToAdmit>string</DecisionToAdmit>
<AdmissionMethod>string</AdmissionMethod>
<AdmissionSource>string</AdmissionSource>
<SourceOfReferral>string</SourceOfReferral>
<ReferralDate>string</ReferralDate>
<IntendedManagement>string</IntendedManagement>
<PsychiatricAdmissionStatus>string</PsychiatricAdmissionStatus>
<AdmissionLegalStatus>string</AdmissionLegalStatus>
<CensusLegalStatus>string</CensusLegalStatus>
<MentalCategory>string</MentalCategory>
<TenancyDescription>string</TenancyDescription>
<BedLocation>string</BedLocation>
</LatestInpatientDetails>
</Inpatient>
<Outpatient>
<FutureAppointmentCount>0</FutureAppointmentCount>
<PastAppointmentCount>0</PastAppointmentCount>
<LatestOutpatientAppointmentDetails>
<AttendanceDate>string</AttendanceDate>
<LocationType>string</LocationType>
<AppointmentType>string</AppointmentType>
<ClinicianName>string</ClinicianName>
<AttendanceOutcome>string</AttendanceOutcome>
<AttendedOrDna>string</AttendedOrDna>
<TenancyDescription>string</TenancyDescription>
</LatestOutpatientAppointmentDetails>
</Outpatient>
</Summary>
<Detail>
<OpenReferrals>
<ReferralSourceDescription>string</ReferralSourceDescription>
<Referrer>string</Referrer>
<ContactNumber>string</ContactNumber>
<ReferralDate>string</ReferralDate>
<UrgencyDescription>string</UrgencyDescription>
<ReferralReason>string</ReferralReason>
<TeamReferredTo>string</TeamReferredTo>
<HCPReferredTo>string</HCPReferredTo>
<SpecialtyDescription>string</SpecialtyDescription>
<DateReceived>string</DateReceived>
<CareSetting>string</CareSetting>
<DateAccepted>string</DateAccepted>
<TenancyDescription>string</TenancyDescription>
</OpenReferrals>
<DischargedReferrals>
<DischargeDate>string</DischargeDate>
<DischargeHCP>string</DischargeHCP>
<DischargeReason>string</DischargeReason>
<ReferralSourceDescription>string</ReferralSourceDescription>
<Referrer>string</Referrer>
<ContactNumber>string</ContactNumber>
<ReferralDate>string</ReferralDate>
<UrgencyDescription>string</UrgencyDescription>
<ReferralReason>string</ReferralReason>
<TeamReferredTo>string</TeamReferredTo>
<HCPReferredTo>string</HCPReferredTo>
<SpecialtyDescription>string</SpecialtyDescription>
<DateReceived>string</DateReceived>
<CareSetting>string</CareSetting>
<DateAccepted>string</DateAccepted>
<TenancyDescription>string</TenancyDescription>
</DischargedReferrals>
<InpatientActivity>
<LeaveofAbsence>true</LeaveofAbsence>
<AdmissionDate>string</AdmissionDate>
<DischargeDate>string</DischargeDate>
<Location>string</Location>
<ClinicianName>string</ClinicianName>
<Specialty>string</Specialty>
<DecisionToAdmit>string</DecisionToAdmit>
<AdmissionMethod>string</AdmissionMethod>
<AdmissionSource>string</AdmissionSource>
<SourceOfReferral>string</SourceOfReferral>
<ReferralDate>string</ReferralDate>
<IntendedManagement>string</IntendedManagement>
<PsychiatricAdmissionStatus>string</PsychiatricAdmissionStatus>
<AdmissionLegalStatus>string</AdmissionLegalStatus>
<CensusLegalStatus>string</CensusLegalStatus>
<MentalCategory>string</MentalCategory>
<TenancyDescription>string</TenancyDescription>
<BedLocation>string</BedLocation>
</InpatientActivity>
<FutureOutpatientActivity>
<AttendanceDate>string</AttendanceDate>
<LocationType>string</LocationType>
<AppointmentType>string</AppointmentType>
<ClinicianName>string</ClinicianName>
<AttendanceOutcome>string</AttendanceOutcome>
<AttendedOrDna>string</AttendedOrDna>
<TenancyDescription>string</TenancyDescription>
</FutureOutpatientActivity>
<PastOutpatientActivity>
<AttendanceDate>string</AttendanceDate>
<LocationType>string</LocationType>
<AppointmentType>string</AppointmentType>
<ClinicianName>string</ClinicianName>
<AttendanceOutcome>string</AttendanceOutcome>
<AttendedOrDna>string</AttendedOrDna>
<TenancyDescription>string</TenancyDescription>
</PastOutpatientActivity>
</Detail>
</RIOCommunity.Models.CommunityMentalHealthActivity.Response>{
"description": "The store patient alert response.",
"type": "object",
"properties": {
"Summary": {
"description": "Gets or sets the summary.",
"type": "object",
"properties": {
"Referrals": {
"description": "Gets or sets the referrals.",
"type": "object",
"properties": {
"ReferredSpecialties": {
"description": "Referred Specialties.",
"type": "string"
},
"OpenReferralCount": {
"format": "int32",
"description": "Open Referral Count.",
"type": "integer"
},
"DischargeReferralCount": {
"format": "int32",
"description": "Discharge Referral Count.",
"type": "integer"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
},
"Inpatient": {
"description": "Gets or sets the inpatient.",
"type": "object",
"properties": {
"Status": {
"description": "Inpatient Status.",
"type": "object",
"properties": {
"LeaveOfAbsence": {
"description": "Leave Of Absence.",
"type": "boolean"
},
"CurrentInpatient": {
"description": "Current Inpatient.",
"type": "boolean"
}
}
},
"AdmissionCount6Month": {
"format": "int32",
"description": "Admission Count in last 6 Month.",
"type": "integer"
},
"TotalAdmissionCount": {
"format": "int32",
"description": "Total Admission Count.",
"type": "integer"
},
"LatestInpatientDetails": {
"description": "Latest Inpatient Details.",
"type": "object",
"properties": {
"LeaveofAbsence": {
"description": "Gets or sets a value indicating whether [leaveof absence].",
"type": "boolean"
},
"AdmissionDate": {
"format": "date-time",
"description": "Gets or sets the admission date.",
"type": "string"
},
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"Location": {
"description": "Gets or sets the location.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"Specialty": {
"description": "Gets or sets the specialty.",
"type": "string"
},
"DecisionToAdmit": {
"format": "date-time",
"description": "Gets or sets the decision to admit.",
"type": "string"
},
"AdmissionMethod": {
"description": "Gets or sets the admission method.",
"type": "string"
},
"AdmissionSource": {
"description": "Gets or sets the admission source.",
"type": "string"
},
"SourceOfReferral": {
"description": "Gets or sets the source of referral.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"IntendedManagement": {
"description": "Gets or sets the intended management.",
"type": "string"
},
"PsychiatricAdmissionStatus": {
"description": "Gets or sets the psychiatric admission status.",
"type": "string"
},
"AdmissionLegalStatus": {
"description": "Gets or sets the admission legal status.",
"type": "string"
},
"CensusLegalStatus": {
"description": "Gets or sets the census legal status.",
"type": "string"
},
"MentalCategory": {
"description": "Gets or sets the mental category.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
},
"BedLocation": {
"description": "Bed Location.",
"type": "string"
}
}
}
}
},
"Outpatient": {
"description": "Gets or sets the outpatient.",
"type": "object",
"properties": {
"FutureAppointmentCount": {
"format": "int32",
"description": "Future Appointment Count.",
"type": "integer"
},
"PastAppointmentCount": {
"format": "int32",
"description": "Past Appointment Count.",
"type": "integer"
},
"LatestOutpatientAppointmentDetails": {
"description": "Latest Outpatient Appointment Details.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
}
}
}
},
"Detail": {
"description": "Gets or sets the detail.",
"type": "object",
"properties": {
"OpenReferrals": {
"description": "Open Referrals collection.",
"type": "array",
"items": {
"description": "The referral.",
"type": "object",
"properties": {
"ReferralSourceDescription": {
"description": "Gets or sets the referral source description.",
"type": "string"
},
"Referrer": {
"description": "Gets or sets the referrer.",
"type": "string"
},
"ContactNumber": {
"description": "Gets or sets the contact number.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"UrgencyDescription": {
"description": "Gets or sets the urgency description.",
"type": "string"
},
"ReferralReason": {
"description": "Gets or sets the referral reason.",
"type": "string"
},
"TeamReferredTo": {
"description": "Gets or sets the team referred to.",
"type": "string"
},
"HCPReferredTo": {
"description": "Gets or sets the HCP referred to.",
"type": "string"
},
"SpecialtyDescription": {
"description": "Gets or sets the specialty description.",
"type": "string"
},
"DateReceived": {
"format": "date-time",
"description": "Gets or sets the date received.",
"type": "string"
},
"CareSetting": {
"description": "Gets or sets the care setting.",
"type": "string"
},
"DateAccepted": {
"format": "date-time",
"description": "Gets or sets the date accepted.",
"type": "string"
},
"TenancyDescription": {
"description": "Gets or sets the tenancy description.",
"type": "string"
}
}
}
},
"DischargedReferrals": {
"description": "Discharged Referrals collection.",
"type": "array",
"items": {
"description": "The discharged referral.",
"type": "object",
"properties": {
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"DischargeHCP": {
"description": "Gets or sets the discharge HCP.",
"type": "string"
},
"DischargeReason": {
"description": "Gets or sets the discharge reason.",
"type": "string"
},
"ReferralSourceDescription": {
"description": "Gets or sets the referral source description.",
"type": "string"
},
"Referrer": {
"description": "Gets or sets the referrer.",
"type": "string"
},
"ContactNumber": {
"description": "Gets or sets the contact number.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"UrgencyDescription": {
"description": "Gets or sets the urgency description.",
"type": "string"
},
"ReferralReason": {
"description": "Gets or sets the referral reason.",
"type": "string"
},
"TeamReferredTo": {
"description": "Gets or sets the team referred to.",
"type": "string"
},
"HCPReferredTo": {
"description": "Gets or sets the HCP referred to.",
"type": "string"
},
"SpecialtyDescription": {
"description": "Gets or sets the specialty description.",
"type": "string"
},
"DateReceived": {
"format": "date-time",
"description": "Gets or sets the date received.",
"type": "string"
},
"CareSetting": {
"description": "Gets or sets the care setting.",
"type": "string"
},
"DateAccepted": {
"format": "date-time",
"description": "Gets or sets the date accepted.",
"type": "string"
},
"TenancyDescription": {
"description": "Gets or sets the tenancy description.",
"type": "string"
}
}
}
},
"InpatientActivity": {
"description": "Inpatient Activity collection.",
"type": "array",
"items": {
"description": "The inpatient.",
"type": "object",
"properties": {
"LeaveofAbsence": {
"description": "Gets or sets a value indicating whether [leaveof absence].",
"type": "boolean"
},
"AdmissionDate": {
"format": "date-time",
"description": "Gets or sets the admission date.",
"type": "string"
},
"DischargeDate": {
"format": "date-time",
"description": "Gets or sets the discharge date.",
"type": "string"
},
"Location": {
"description": "Gets or sets the location.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"Specialty": {
"description": "Gets or sets the specialty.",
"type": "string"
},
"DecisionToAdmit": {
"format": "date-time",
"description": "Gets or sets the decision to admit.",
"type": "string"
},
"AdmissionMethod": {
"description": "Gets or sets the admission method.",
"type": "string"
},
"AdmissionSource": {
"description": "Gets or sets the admission source.",
"type": "string"
},
"SourceOfReferral": {
"description": "Gets or sets the source of referral.",
"type": "string"
},
"ReferralDate": {
"format": "date-time",
"description": "Gets or sets the referral date.",
"type": "string"
},
"IntendedManagement": {
"description": "Gets or sets the intended management.",
"type": "string"
},
"PsychiatricAdmissionStatus": {
"description": "Gets or sets the psychiatric admission status.",
"type": "string"
},
"AdmissionLegalStatus": {
"description": "Gets or sets the admission legal status.",
"type": "string"
},
"CensusLegalStatus": {
"description": "Gets or sets the census legal status.",
"type": "string"
},
"MentalCategory": {
"description": "Gets or sets the mental category.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
},
"BedLocation": {
"description": "Bed Location.",
"type": "string"
}
}
}
},
"FutureOutpatientActivity": {
"description": "Future Outpatient Activity Collection.",
"type": "array",
"items": {
"description": "The outpatient.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
},
"PastOutpatientActivity": {
"description": "Past Outpatient Activity Collection.",
"type": "array",
"items": {
"description": "The outpatient.",
"type": "object",
"properties": {
"AttendanceDate": {
"format": "date-time",
"description": "Gets or sets the attendance date.",
"type": "string"
},
"LocationType": {
"description": "Gets or sets the type of the location.",
"type": "string"
},
"AppointmentType": {
"description": "Gets or sets the type of the appointment.",
"type": "string"
},
"ClinicianName": {
"description": "Gets or sets the name of the clinician.",
"type": "string"
},
"AttendanceOutcome": {
"description": "Gets or sets the attendance outcome.",
"type": "string"
},
"AttendedOrDna": {
"description": "Gets or sets the attended or dna.",
"type": "string"
},
"TenancyDescription": {
"description": "Tenancy Description.",
"type": "string"
}
}
}
}
}
}
}
}400 Bad Request
Invalid parameter supplied
Representations
401 Unauthorized
Invalid credentials supplied
Representations
404 Not Found
Specified entity was not found or access denied
Representations
Code samples
@ECHO OFF
curl -v -X GET "https://graphnet-api-nonprod.azure-api.net/comm-mh/Patients/{detailID}/CommunityMentalHealthActivity?pastResults=10&futureResults=10"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
client.DefaultRequestHeaders.Add("Authorization", "{access token}");
// Request parameters
queryString["pastResults"] = "10";
queryString["futureResults"] = "10";
var uri = "https://graphnet-api-nonprod.azure-api.net/comm-mh/Patients/{detailID}/CommunityMentalHealthActivity?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://graphnet-api-nonprod.azure-api.net/comm-mh/Patients/{detailID}/CommunityMentalHealthActivity");
builder.setParameter("pastResults", "10");
builder.setParameter("futureResults", "10");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
request.setHeader("Authorization", "{access token}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"pastResults": "10",
"futureResults": "10",
};
$.ajax({
url: "https://graphnet-api-nonprod.azure-api.net/comm-mh/Patients/{detailID}/CommunityMentalHealthActivity?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","{access token}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://graphnet-api-nonprod.azure-api.net/comm-mh/Patients/{detailID}/CommunityMentalHealthActivity";
NSArray* array = @[
// Request parameters
@"entities=true",
@"pastResults=10",
@"futureResults=10",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
[_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://graphnet-api-nonprod.azure-api.net/comm-mh/Patients/{detailID}/CommunityMentalHealthActivity');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
'Authorization' => '{access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'pastResults' => '10',
'futureResults' => '10',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.urlencode({
# Request parameters
'pastResults': '10',
'futureResults': '10',
})
try:
conn = httplib.HTTPSConnection('graphnet-api-nonprod.azure-api.net')
conn.request("GET", "/comm-mh/Patients/{detailID}/CommunityMentalHealthActivity?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.parse.urlencode({
# Request parameters
'pastResults': '10',
'futureResults': '10',
})
try:
conn = http.client.HTTPSConnection('graphnet-api-nonprod.azure-api.net')
conn.request("GET", "/comm-mh/Patients/{detailID}/CommunityMentalHealthActivity?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://graphnet-api-nonprod.azure-api.net/comm-mh/Patients/{detailID}/CommunityMentalHealthActivity')
query = URI.encode_www_form({
# Request parameters
'pastResults' => '10',
'futureResults' => '10'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body