May 16, 2024: Preview FHIR REST APIs now contain correct full links for pagination

Today, users of the preview FHIR RESTful APIs available at https://fqs.zusapi.com/rest can now supply a header "X-New-Pagination" to receive the full URL schema in next and previous links, which conforms to FHIR's RESTful API's standards. This will allow users to update their integrations to take into account the correct URL in links.

The preview FHIR RESTful APIs will be defaulting to this link format on May 31, 2024 or earlier if all API consumers have transitioned appropriately. After May 31, 2024, users will no longer need to supply the "X-New-Pagination" header, and the header will be ignored in requests.

For example, when retrieving all FHIR Encounters associated with a patient assigned UPID abc123, a user can execute the following query:

GET https://fqs.zusapi.com/rest/Encounter?upid=abc123

If the search returns more than 10 resources, the response will return a Bundle containing only the first 10 and a link which will return the next 10, etc. Without the "X-New-Pagination" header, the link URLs will not contain https://

  "link":[  
        {  
            "relation": "self",  
            "url": "fqs.zusapi.com/rest/Encounter?upid=abc123"  
        },  
        {  
            "relation": "next",  
            "url": "fqs.zusapi.com/rest/Encounter?_after=eyJrZXki...&upid=abc123"
        }
    ]

With the header "X-New-Pagination:true", the link URLs will contain the full URL schema, including https://

  "link":[  
        {  
            "relation": "self",  
            "url": "https://fqs.zusapi.com/rest/Encounter?upid=abc123"  
        },  
        {  
            "relation": "next",  
            "url": "https://fqs.zusapi.com/rest/Encounter_after=eyJrZXki...&upid=abc123"
        }
    ]