Medical Certificate

medical-certificates

POST

medical-certificates

Description

Allows software vendors to create a medical certificate with ACC.
The medical certificate is a secondary interaction (linked to a Claim) if
1. A patient:

  • Needs time off work beyond the first two weeks;
  • Needs additional support to operate in life or getting to / from work;
  • Presents additional complications that need to be considered;

2. The Provider:

  • Needs extra support services to assist with diagnosis.

This can only be generated by a Doctor or Nurse Practitioner. They are mostly generated with the claim at the patient first visit but can be generated as part of a subsequent visit or by a different registered provider at a subsequent visit.

Testing scenarios can be found here, and FAQs by clicking here.

Resource Summary

Security

Type

application/json

Category

Medical Certificates

URL

https://provider.api-compliance.acc.co.nz/api/v2/claims/medical-certificates

Supporting Documentation

Body Parameters


Name Values Description
body
(required)

Request Body

MedicalCertificate {

pmsSoftwareName:
pmsSoftwareVersion:
claimNumber:
 string
1-12 alphanumeric characters. Examples: A123456, AA12345, 1234567, 12345678901, A1234567890 where A represents an alphabetic character and each digit represents any digit.
declaration:
Declaration {
providerDeclaration:
 string * (date)
The date the form was submitted.
}
diagnosis:
[
If present, this must contain at least one diagnosis. 20 diagnoses permitted.
Diagnosis {
diagnosisCodeType:
 string *
See the DiagnosisCodingSystem code tables for valid values.
diagnosisCode:
 string *
Alphanumeric, can include '.'
diagnosisDescription:
diagnosisSide:
diagnosisComment:
diagnosisAction:
primaryDiagnosisIndicator:
 string *
Select exactly one diagnosis in a request as primary.
}
]
patient:
Patient {
address:
Address {
type:
line1:
line2:
suburb:
city:
postCode:
country:
}
contact:
Contact {
emailAddress:
mobilePhone:
homePhone:
workPhone:
}
details:
PatientDetails {
accidentDate:
dateOfBirth:
nhi:
firstName:
middleName:
surname:
}
}
provider:
Provider {
address:
Address {
type:
line1:
line2:
suburb:
city:
postCode:
country:
}
contact:
Contact {
emailAddress:
mobilePhone:
homePhone:
workPhone:
}
details:
ProviderDetails {
providerId:
 string *
The provider's ACC or HPI number, 1-8 characters.
providerTypeCode:
 string *
See the ProviderType code tables for valid values.
firstName:
middleName:
surname:
}
}
vendor:
Vendor {
hpiFacilityNumber:
 string
ID of the facility where the service was provided.
hpiOrganisationNumber:
 string *
1-12 alphanumeric characters, can include '\\'
practiceName:
 string *
1-40 characters.
}
workCapacity:
WorkCapacity {
incapacity:
[
You can define up to 3 periods of incapacity. Each one must have a type and a date range.
Incapacity {
incapacityType:
 string *
You can select 'fully unfit' no more than once, and 'fit for selected' no more than twice.
incapacityDateRange:
DateRange {
A valid date is required for each incapacity type selected.
fromDate:
 string * (date)
Date ranges must have no gaps and no overlaps.
toDate:
 string * (date)
Date ranges must have no gaps and no overlaps.
}
incapacityComments:
 string
Only required when Fullyunfitforwork is true.
selectedAlternativeWork:
SelectedAlternativeWork {
restrictionComment:
 string
Optional if Fitforselectedwork is true.
restrictedHoursPerDay:
 number (double)
Optional, values 0.50 through 16.00
restrictedDaysPerWeek:
 integer (int32)
Optional, values 1 through 7
physicalRestrictions:
[
Optional if Fitforselectedwork is true, otherwise not permitted. Any of the listed items can be selected once, up to 11 choices.
PhysicalRestrictions {
restriction:
}
]
}
}
]
reviewIncapacityDate:
 string (date)
The date when ACC should check whether the patient is recovering as expected.
returnToWork:
ReturnToWork {
assistanceRequired:
 string *
Is return to work assistance required?
assistanceType:
 string
Only required when assistanceRequired is true.
}
accAssistance:
AccAssistance {
issuesDetails:
 string
What complications or other issues are affecting recovery or rehabilitation?
otherComments:
 string
What other assistance (equipment, home help, transport) should the patient discuss with a case manager?
}
contactRequired:
 string *
True if the provider wants an ACC case manager to get in touch.
accContact:
AccContact {
anyDay:
 string
Only required when contactRequired is true.
preferredContactDay:
[
Only required when contactRequired is true and anyDay is false.
]
contactComments:
 string
Optional when contactRequired is true.
}
}

}

Operations

Basic HTTP authentication

Set

OAuth 2 authentication

Set

API Key custom token

Set

Working...

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 202

    Accepted

  • 400

    Bad Request: invalid data

  • 401

    Unauthorized: authentication error

  • 403

    Forbidden: authorization error

  • 404

    Not Found

  • 500

    Internal Server Error