Skip to content
This repository has been archived by the owner on Dec 16, 2019. It is now read-only.

Add a Flask API to serve the data format #4

Open
LaRiffle opened this issue Oct 23, 2018 · 4 comments
Open

Add a Flask API to serve the data format #4

LaRiffle opened this issue Oct 23, 2018 · 4 comments
Assignees
Labels

Comments

@LaRiffle
Copy link
Member

Having an API to serve this files that represents the FHIR format would be very valuable. One direct application would be for our interface fhir-ball to fetch the Resource structure on which the user will do the mapping.

Beyond that, it allows external user to access the standard in their preferred format (json, yml, etc) in a very simple way, and without having to worry about about the latest release.

A good implementation would be to do this with Flask.

@jblemoine jblemoine self-assigned this Oct 28, 2018
@jblemoine
Copy link
Contributor

jblemoine commented Oct 29, 2018

Can you specify, what the API input and the output would be ? (And illustrate it with a short query template pls)

@LaRiffle
Copy link
Member Author

Store
I think it would be like this:

The input is:

  • the type of request ('store' for accessing the store)
  • the ouput type ('yml', 'json')
  • the name of a FHIR Ressource (ex: "Patient")

The output is:

api.get('api.arkhn.com/store/yml/Patient')

Returns

resourceType: "Patient"
identifierlist::Identifier:
active:
...

@LaRiffle
Copy link
Member Author

Also, the API could be useful to serve mapping file as well:

@LaRiffle
Copy link
Member Author

LaRiffle commented Oct 31, 2018

Mapping

The input is:

  • the type of request ('mapping' for accessing the mapping rules)
  • The database (ex: 'CW')
  • the ouput type ('yml', 'json')
  • the name of a FHIR Ressource (ex: "Patient")

The output is:

api.get('api.arkhn.com/mapping/CW/yml/Patient')

Returns

info:
source_table: 'ICSF.PATIENT'
fhir:
resourceType: 'Patient'
identifierlist::Identifier:
_join:
_type: 'OneToOne'
_args: ['ICSF.PATIENT.NOPAT=ICSF.PATCOMP.NOPAT']
...

Should be case insensitive I think

alexisthual added a commit that referenced this issue Nov 6, 2018
[WIP] ENH: RESTful API to serve the data format #4
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants