gered/clj-hl7-fhir
Archived
1
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases Wiki Activity

add a section explaining some general/common things about the api

Browse source
This commit is contained in:
Gered 2014-08-05 15:19:09 -04:00
parent 23baab2fae
commit c190b48ce0
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -53,6 +53,23 @@ All of the functions that wrap FHIR API calls are located in `clj-hl7-fhir.core`
(use 'clj-hl7-fhir.core) (use 'clj-hl7-fhir.core)
``` ```
### General Concepts
Most API functions take a `type` parameter which should be either a keyword or string
specifying the [FHIR resource](http://hl7.org/implement/standards/fhir/resourcelist.html)
that the operation is dealing with. The resource can be specified either in "camel case"
(e.g. `"Patient"` or `"DiagnosticReport"`) or in "kebab case", which is what most Clojure
code uses (e.g. `:patient` or `:diagnostic-report`). FHIR servers will typically return
an error if you pass in a resource type that is not recognized.
Return values will almost always (if not nil) be a FHIR resource or bundle ([as described here](http://hl7.org/implement/standards/fhir/json.html).
The main difference is that a bundle can contain any number of resources (even zero) and
also contains a bit of extra metadata about each resource contained inside. The functions
which return resources as bundles will always return a bundle as long as an error did
not occur, however the bundle may contain zero resources. The functions which return
raw resources will either return a resource or nil on success. Exceptions to this
will be noted in the individual function documentation (e.g. `create` and `update`).
### base-url ### base-url
All core API functions take a `base-url` parameter. This is the [Service Root URL](http://hl7.org/implement/standards/fhir/http.html#root) All core API functions take a `base-url` parameter. This is the [Service Root URL](http://hl7.org/implement/standards/fhir/http.html#root)