SHINNYIG - Local Development build (v0.2). See the Directory of published versions
Home
| Official URL: http://shinny.org/ImplementationGuide/fhir.shinny | Version: 0.2 | |||
| Active as of 2023-07-28 | Computable Name: SHINNYIG | |||
SHIN-NY IG
Introduction
“An implementation guide (IG) is a set of rules about how FHIR resources are used to solve a particular problem, with associated documentation to support and clarify the usage”. It also provides documentation about individual resource profiles that can be used by FHIR implementers. The FHIR profiles, that are contained in an IG, provide a way to customize resources by allowing one to create use case specific definitions, constraints and/or extensions on base resources.
The SHIN-NY IG extends from a limited set of US Core resource profiles to take advantage some of their extensions, terminology sets and value set bindings while relaxing many of the cardinality rules and constraints to allow for less than ideal data to be able to be transmitted over the wire.
In its current iteration the SHIN-NY IG only has profiles on the resources below. This list will be extended to cover all resources necessary to support all FHIR transformations.
- Bundle
- Encounter
- Patient
- Observation
- Condition
- Procedure
Preferably, clinical data will be sent throughout the day as it is received by QEs; however, at a minimum, all hospital encounter and laboratory data transmitted to a QE by participants on a given day must be sent by 10:00 AM ET the following day.
See the SHIN-NY IG Tracker on the Extranet for clinical data assumptions & decisions: SHIN-NY IG Tracker.xlsx
Supported REST API Calls
The data lake Rest API will only support the following HTTP methods and routes:
| Route | HTTP Method | Action |
|---|---|---|
| http://shinny.org/Bundle/ | POST | Create or Update a resource |
| http://shinny.org/Bundle/:resource_id | DELETE | DELETE an all existing resources contained in the Bundle |
The data lake API will not support the full set of FHIR routes that are supported by a typical FHIR Server.
Routes such as the ones below will not be supported:
- _history
- _validate
- $meta-*
- diff
- graphql
The data lake will not persist any FHIR Bundle resources. Only the individual FHIR resources contained within the
Bundle will be persisted. It is expected that the calling application will always provide a resource id
(FHIR Resource logical id) and that logical id will be used to make any subsequent updates to any FHIR resources.
It is not expected that a resource id is provided in the URI during a POST call by the calling application.
All resource ids in the URI will always be ignored since the Bundle resource is not persisted.
HTTP method recommendations:
- Always use POST for CREATE & UPDATE operations.
- POST is idempotent. If a request is submitted N times with the SAME resource Id the resources contained will NOT be created N times within the data lake
- The Meta.lastUpdated attribute will be required to ensure FHIR resources get processed in the appropriate order.
If an error occurs during the processing of any HTTP call a FHIR OperationOutcome resource will be returned providing detailed information about the outcome of an attempted system operation.
High Level Architecture
Data Ingest Workflow
SHINNY Data Lake Open API
API Endpoints
| QE Name | ENV | API Endpoint |
|---|---|---|
| Bronx RHIO | DEV | https://5hlpkcpksa.execute-api.us-east-1.amazonaws.com/dev |
| HEALTHeLINK | DEV | https://7kf806hh44.execute-api.us-east-1.amazonaws.com/dev |
| Healthix | DEV | https://u8f4ckrx73.execute-api.us-east-1.amazonaws.com/dev |
| HealtheConnections | DEV | https://ozr8udz0re.execute-api.us-east-1.amazonaws.com/dev |
| Hixny | DEV | https://ggexmhfffg.execute-api.us-east-1.amazonaws.com/dev |
| Rochester RHIO | DEV | https://go2j9ega88.execute-api.us-east-1.amazonaws.com/dev |
Release Notes
Fixes and New Additions
0.1 June 14th 2023
- Added a SHINNY Data Lake Open API download link to this page
- Changed the Bundle.type to support only transaction
- Removed HTTP PUT from the SHINNYHTTPVerbsVS. Only POST and DELETE are now supported
- Made Meta required in the SHINNYObservation & Procedure (this is required for all resources)
- Made id required in the SHINNYObservation & Procedure (this is required for all resources)
- Changed SHINNYProcedure.subject reference to SHINNYPatientProfile
- Changed SHINNYProcedure.encounter reference to SHINNYEncounterProfile
- Changed SHINNYDiagnosis.meta to SHINNYMeta
- Changed SHINNYProcedure.recorder to include SHINNYPatientProfile
- Changed SHINNYProcedure.asserter to include SHINNYPatientProfile
0.1.1 June 16th 2023
- QE API Endpoints were added to this document
- Encounter.episodeOfCare cardinality was changed from 0..1 to 0..*
- Observation.performer References now inlude all of the following: USCorePractitionerProfile or USCorePractitionerRoleProfile or USCoreOrganizationProfile or USCoreCareTeam or SHINNYPatientProfile or USCoreRelatedPersonProfile
0.1.2 July 21, 2023
- Removed references to ADT & ORU
- Added minimum frequency for QE’s to send clinical data to SHIN-NY
- Added link to SHIN-NY IG Tracker
0.1.3 July 26, 2023
- Added Patient.identifier slice for ‘MR’ (MRN).
- Removed the const key word (JSON Schema constant) from the open-api yaml file which was causing an error. It made it in the yaml file from the FHIR schema JSON translation.
0.1.4 July 28, 2023
- Changed Observation.focus from a reference to an Encounter to a reference of a Resource (supports any resource)