ODS Helper 2018-04-09T22:45:15+00:00

Library : ODS Helper

Library Overview

This helper library is intended for use with the NHS ODS API service provided by NHS Digital. The ODS API uses FHIR Organization resources to represent ODS data. A number of different extensions are used in order to cater for the complexity of the ODS data.

The ODS API is published at https://developer.nhs.uk/apis/ods/

GitHub Repo

Makes use of the FHIR .NET Project

This library makes use of the official FHIR .NET library available as an opensource project on GitHub.

Your Content Goes Here

GitHub Repo

Example ODS Organization Resource

Click the button below to see examples of an ODS Organisation represented using a FHIR Organization resource,

See Examples

Organisation Type Helpers

ODSOrganisationType()

Returns an enumeration denoting whether the ODS record is a “Organisations” or a “Site” record.

ODSIsTypeOrganisation()

Returns a FHIR Boolean denoting whether the ODS record is an Organisation record or not. NOTE a null value is returned if no type details are within the record.

ODSIsTypeSite()

Returns a FHIR Boolean denoting whether the ODS record is a Site record or not. NOTE a null value is returned if no type details are within the record.

Organisation Active Period Helpers

ODSActivePeriodLegal()

Checks for the presence of a “https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-ActivePeriod-1” extension for a “Legal” period. If present returns the FHIR Period otherwise a null is returned.

ODSActivePeriodOperational()

Checks for the presence of a “https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-ActivePeriod-1” extension for an “Operational” period. If present returns the FHIR Period otherwise a null is returned.

Organisation Primary Role Helpers

An ODS record can have one or more organisation roles defines using extension “https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1”. One of the roles will be designated the primary role.

ODSRoleCount()

Returns an integer count of the number of roles the ODS record has.

ODSPrimaryRole()

Returns a FHIR Coding for the primary role for the ODS record.

ODSPrimaryRoleIndex()

Returns the index (zero-based) of the roles, denoting which is the primary role.