These pages assist with requirements gathering and mapping stages of a FHIR API development process.

Approach to Engagement

This process lays down steps of engagement with the client to analyse their business requirements for interoperability in a way that it supports mapping your requirements to CareConnect Profiles (that user HL7 INTEROPen FHIR standards) and enable the development of a live API (Application Programming Interface) to read or exchange information/data.

It has been cited that it’s very difficult to exchange information between various business units in health care sector as most of them follow their own data structures to exchange information. This causes lot of interoperability issues and rework. Implementing this process gives us the opportunity to demonstrate and guide the business units as to how these issues can be resolved using standards- FHIR (Fast Health Information Resources) and Care Connect Profiles which adhere to interoperability standards defined by INTEROPen community ( A standardised approach will provide a common language for engagement and will more easily support a framework for sharing knowledge that can continue to assist future projects and possibly become self sustaining within the community.

Business Benefit

This process will add business value by enabling businesses to easily exchange information in a common format as defined by FHIR and Profiles which is easily understood by rest of the organisation.

The Process

The process is broken down into 15 discrete steps that are broadly organised onto three stages: Agree Business Requirements, Define the Solution, and Deliver the Solution.

Diagram showing the process stages for agreeing business requirements, then defining and delivering the solution

Agree Business Requirements

StepDescriptionFormal Output
1Document Client's ContextGive a brief description of the client we are engaging with and what led them to the business need for interoperability.
  • Short Textual Statement
2Document Case OverviewDescription of the client's business needs and expectations.
  • Short Textual Statement
3Document Problem StatementDescribe the current ineroperability issues.
  • Problem Statement Diagram
4Identify Business RequirementsVisually represent the business case to confirm understanding of the problem with the client.
5Identify DatasetGiven that the solution is likely to be implemented against existing systems it should be straightforward to identify which data items the client wants to send or receive between those systems. Get XML representation of the data structure if possible.
  • Data Set
  • Data Structure

Define the Solution

StepDescriptionFormal Output
6Identify Care Connect Profiles and FHIR ResourcesIdentify which Care Connect profiles and FHIR resources can be used to meet the requirement. An entity relationship diagram can help to describe the profiles.
  • Entity Relationship Diagram
7Map DatasetMap the dataset to the profile.
  • Dataset Mapping
8Obtain ApprovalGet Profile to Dataset Mapping reviewed and approved by the client.
9Design APIDefine API Signatures and use of Search Parameters
  • API Signature
  • Search Parameters
  • Search Results
10Document Interaction FlowDefine the sequence of interactions expected including the function, input parameters, output parameters etc.
  • API Sequence Diagram
11Document Additional Technical ContextIdentify any further technical considerations to aid understanding.
  • System Diagrams
  • Acceptance Criteria
12Resolve Curation RequirementsFeedback to INTEROPen any necessary changes to Profile definitions.
  • Updated Care Connect Standards

Deliver the Solution

StepDescriptionFormal Output
13Present Case StudyPresent final case study to stakeholders and include it into the implementation guide.
  • Presentation
  • Updated Implementation Guide
14Implement SolutionClient implements solution, tests and provides feedback.
15LearningIdentify failures and successes of the project.
  • Plan to improve processes, preventing a repeat of failure and improving success rate.