openapi: 3.2.0 info: title: Partner Organisation API version: '1.2' tags: - name: organisation paths: /api/v1/organisation/GetOrganisation: get: tags: - organisation description: This call returns details about the practice administration including users, locations and location types. operationId: GetOrganisation parameters: - name: applicationId in: header description: The applicationId (aka party key) will be provided by your assurance lead required: true schema: type: string responses: '500': description: Internal error content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' application/json: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' '400': description: Bad request - adjust URL or parameters content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' application/json: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' '401': description: Authentication token not valid content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' application/json: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' '404': description: Not found content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' application/json: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' '415': description: Media type not valid for URL content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' application/json: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' '200': description: Retrieves organisation details content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.OrganisationInformation' application/json: schema: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.OrganisationInformation' security: - bearer: [] - OAuth2CodeEMIS-X-GP-PAPI: - papi-config.read /api/v1/organisation/GetOrganisationV2: get: tags: - organisation description: This call returns details about the practice administration including users, locations and location types. operationId: GetOrganisationV2 parameters: - name: applicationId in: header description: The applicationId (aka party key) will be provided by your assurance lead required: true schema: type: string responses: '500': description: Internal error content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' application/json: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' '400': description: Bad request - adjust URL or parameters content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' application/json: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' '401': description: Authentication token not valid content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' application/json: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' '404': description: Not found content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' application/json: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' '415': description: Media type not valid for URL content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' application/json: schema: $ref: '#/components/schemas/PartnerApi.Service.Model.ErrorResponse' '200': description: Retrieves organisation details content: application/xml: schema: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.OrganisationInformationV2' application/json: schema: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.OrganisationInformationV2' security: - bearer: [] - OAuth2CodeEMIS-X-GP-PAPI: - papi-config.read components: schemas: PartnerApi.Service.Model.Coding: type: object properties: system: type: - string - 'null' code: type: - string - 'null' display: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37.PersonType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' mnemonic: type: - string - 'null' pcsUser: type: - string - 'null' activeEMISUser: type: - string - 'null' title: type: - string - 'null' firstNames: type: - string - 'null' lastName: type: - string - 'null' category: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonCategoryType' nationalCode: type: - string - 'null' prescriptionCode: type: - string - 'null' gmcCode: type: - string - 'null' ukccCode: type: - string - 'null' scripts: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeScripts' scriptsSpecified: type: boolean consulter: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeConsulter' consulterSpecified: type: boolean contractStart: type: - string - 'null' contractEnd: type: - string - 'null' doctor: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeDoctor' doctorSpecified: type: boolean locum: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeLocum' locumSpecified: type: boolean registrar: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeRegistrar' registrarSpecified: type: boolean maternity: type: - string - 'null' childSurveillance: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeChildSurveillance' childSurveillanceSpecified: type: boolean contraceptive: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeContraceptive' contraceptiveSpecified: type: boolean twentyFourHour: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeTwentyFourHour' twentyFourHourSpecified: type: boolean minorSurgery: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeMinorSurgery' minorSurgerySpecified: type: boolean resonsibleHA: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.IdentType' trainer: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.IdentType' contractualRelationship: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeContractualRelationship' contractualRelationshipSpecified: type: boolean address: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.AddressType' telephone1: type: - string - 'null' telephone2: type: - string - 'null' fax: type: - string - 'null' email: type: - string - 'null' role: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.RoleType' activeUser: type: - string - 'null' security1: type: - string - 'null' security2: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.PersonType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' mnemonic: type: - string - 'null' pcsUser: type: - string - 'null' activeEMISUser: type: - string - 'null' title: type: - string - 'null' firstNames: type: - string - 'null' lastName: type: - string - 'null' category: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonCategoryType' nationalCode: type: - string - 'null' prescriptionCode: type: - string - 'null' gmcCode: type: - string - 'null' ukccCode: type: - string - 'null' scripts: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeScripts' scriptsSpecified: type: boolean consulter: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeConsulter' consulterSpecified: type: boolean contractStart: type: - string - 'null' contractEnd: type: - string - 'null' doctor: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeDoctor' doctorSpecified: type: boolean locum: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeLocum' locumSpecified: type: boolean registrar: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeRegistrar' registrarSpecified: type: boolean maternity: type: - string - 'null' childSurveillance: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeChildSurveillance' childSurveillanceSpecified: type: boolean contraceptive: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeContraceptive' contraceptiveSpecified: type: boolean twentyFourHour: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeTwentyFourHour' twentyFourHourSpecified: type: boolean minorSurgery: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeMinorSurgery' minorSurgerySpecified: type: boolean resonsibleHA: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType' trainer: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType' contractualRelationship: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeContractualRelationship' contractualRelationshipSpecified: type: boolean address: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.AddressType' telephone1: type: - string - 'null' telephone2: type: - string - 'null' fax: type: - string - 'null' email: type: - string - 'null' role: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.RoleType' activeUser: type: - string - 'null' security1: type: - string - 'null' security2: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeScripts: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37V2.LocationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' locationName: type: - string - 'null' nationalCode: type: - string - 'null' locationTypeID: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType' address: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.AddressType' telephone1: type: - string - 'null' telephone2: type: - string - 'null' fax: type: - string - 'null' email: type: - string - 'null' contact: type: - string - 'null' cypher: type: - string - 'null' interchange: type: - string - 'null' linkCode: type: - string - 'null' seniorPartner: type: - string - 'null' pcgCode: type: - string - 'null' pctCode: type: - string - 'null' gpLinkCodeList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.LocationTypeGPLinkCode' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeLocum: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37V2.PersonCategoryType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' mnemonic: type: - string - 'null' description: type: - string - 'null' purpose: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonCategoryTypePurpose' purposeSpecified: type: boolean additionalProperties: false PartnerApi.Service.Model.ErrorResponse: type: object properties: messageId: type: string format: uuid text: $ref: '#/components/schemas/PartnerApi.Service.Model.Text' issue: $ref: '#/components/schemas/PartnerApi.Service.Model.Issue' legacyOutcome: type: integer format: int32 additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeConsulter: enum: - 0 - 1 - 2 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeDoctor: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37.LocationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' locationName: type: - string - 'null' nationalCode: type: - string - 'null' locationTypeID: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.IdentType' address: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.AddressType' telephone1: type: - string - 'null' telephone2: type: - string - 'null' fax: type: - string - 'null' email: type: - string - 'null' contact: type: - string - 'null' cypher: type: - string - 'null' interchange: type: - string - 'null' linkCode: type: - string - 'null' seniorPartner: type: - string - 'null' pcgCode: type: - string - 'null' pctCode: type: - string - 'null' gpLinkCodeList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.LocationTypeGPLinkCode' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeMinorSurgery: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37.ApplicationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' applicationMnemonic: type: - string - 'null' applicationName: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeContraceptive: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37.AddressType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' houseNameFlat: type: - string - 'null' street: type: - string - 'null' village: type: - string - 'null' town: type: - string - 'null' county: type: - string - 'null' postCode: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.OrganisationInformationV2: type: object properties: organisationList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.LocationType' userList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonType' externalOrganisationList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.LocationType' externalPersonList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.PersonType' locationTypeList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.TypeOfLocationType' locationList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.LocationType' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.TypeOfLocationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' description: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeContractualRelationship: enum: - 0 - 1 - 2 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeChildSurveillance: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeContraceptive: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeChildSurveillance: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeMinorSurgery: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37.IdentType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeTwentyFourHour: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37V2.RoleType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' application: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.ApplicationType' team: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType' location: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37V2.IdentType' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeTwentyFourHour: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37V2.ApplicationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' applicationMnemonic: type: - string - 'null' applicationName: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeDoctor: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37V2.LocationTypeGPLinkCode: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' linkCode: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.AddressType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' houseNameFlat: type: - string - 'null' street: type: - string - 'null' village: type: - string - 'null' town: type: - string - 'null' county: type: - string - 'null' postCode: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeLocum: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37.TypeOfLocationType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' description: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeRegistrar: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37.PersonCategoryTypePurpose: enum: - 0 - 1 type: integer format: int32 PartnerApi.Service.Model.Details: type: object properties: text: type: - string - 'null' coding: $ref: '#/components/schemas/PartnerApi.Service.Model.Coding' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37.RoleType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' application: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.ApplicationType' team: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.IdentType' location: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.IdentType' additionalProperties: false PartnerApi.Service.Model.Issue: type: object properties: severity: $ref: '#/components/schemas/PartnerApi.Service.Model.SeverityType' code: type: - string - 'null' details: $ref: '#/components/schemas/PartnerApi.Service.Model.Details' diagnostics: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37.LocationTypeGPLinkCode: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' linkCode: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeConsulter: enum: - 0 - 1 - 2 type: integer format: int32 PartnerApi.Service.Model.SeverityType: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37V2.PersonCategoryTypePurpose: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeContractualRelationship: enum: - 0 - 1 - 2 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37V2.PersonTypeRegistrar: enum: - 0 - 1 type: integer format: int32 PartnerApi.EmisOpen.OrganisationInformation37.PersonCategoryType: type: object properties: dbid: type: - string - 'null' refID: type: - string - 'null' guid: type: - string - 'null' fileStatus: type: - string - 'null' mnemonic: type: - string - 'null' description: type: - string - 'null' purpose: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonCategoryTypePurpose' purposeSpecified: type: boolean additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37.OrganisationInformation: type: object properties: organisationList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.LocationType' userList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonType' externalOrganisationList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.LocationType' externalPersonList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.PersonType' locationTypeList: type: - array - 'null' items: $ref: '#/components/schemas/PartnerApi.EmisOpen.OrganisationInformation37.TypeOfLocationType' additionalProperties: false PartnerApi.Service.Model.Text: type: object properties: status: type: - string - 'null' div: type: - string - 'null' additionalProperties: false PartnerApi.EmisOpen.OrganisationInformation37.PersonTypeScripts: enum: - 0 - 1 type: integer format: int32 securitySchemes: bearer: type: http scheme: bearer bearerFormat: JWT OAuth2CodeEMIS-X-GP-PAPI: type: oauth2 flows: authorizationCode: scopes: papi-appt.read: Read Appointments papi-appt.write: Write Appointments papi-cr.read: Read Clinical Record papi-cr.write: Write Clinical Record papi-subjects.read: Read Subjects papi-config.read: Read Config papi-searches.read: Read Searches