The server system (Registry) allow interaction by clients systems via standard RESTful interactions and some custom operations.

Use of HTTP Methods:

• POST: Used to create a new resource. A client server assigns resource ID before submitting to this server. This server will generate unique resource id based off the client resource id.
• PUT: Not supported on this server.
• PATCH: Used for partial updates.

Resource ID Management:

The client server auto-generates id during POST to local client. When syncing to this server, client systems must use server-assigned ID for PATCH operations.

Provenance:

Provenance is required for all operations and must contain:

• target: Resource reference
• agent: Responsible person or system (Practitioner or Organization)
• recorded: Timestamp
• who: Responsible submitting actor

Bundles:

• NgImmClientRegistrationBundle – Register a client (Patient, Practitioner, Encounter, Org, Obs, RelatedPerson, Provenance).
• NgImmRegisterFacilityBundle – Register facilities with Organization, Location, Practitioner, PractitionerRole.
• NgImmUpdateClientBundle – Update client details (Encounter, Observation, Immunization, Practitioner, Organization).
• NgImmManageReportAEFIBundle – Submit/manage AEFI reports (Encounter, Observation, AllergyIntolerance).
• NgImmGenerateReportBundle – Exchange of aggregate data using Measure, MeasureReport, Organization, Practitioner.

Supported Data Exchange:

• Synchronization using bundles
• Registration and update of patients and immunizations
• Lookup and display of vaccinations and schedules