Resource.id

The id of the resource is used in the URL for the resource. Once assigned, this value never changes.

The id can be any combination of upper or lower case ASCII letters ('A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.', with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)

Notts Guidance

The length limit for Data providers will be restricted to 60 characters. This is to enable the local id to be prefixed with the ODS Organisation Code and a period in the Exchange, to esnure uniqueness as part of the wider system.

The only time that a resource does not have an id is when it is being submitted to the server using a CREATE operation. It MUST be used in any UPDATE or DELETE request, as such providers will either have to:

  • capture the system assigned id and maintain a mapping table to the local LoBS id, in order to support updates
  • assign the local LoBS id to the Resource.id as part of the CREATE request (Note this needs to be done as PUT rather than a POST, i.e. the same as an UPDATE)