https://github.com/inferno-framework/fhir_models
FHIR Resource Models
https://github.com/inferno-framework/fhir_models
fhir fhir-models
Last synced: 10 months ago
JSON representation
FHIR Resource Models
- Host: GitHub
- URL: https://github.com/inferno-framework/fhir_models
- Owner: inferno-framework
- License: apache-2.0
- Created: 2016-03-11T13:23:57.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-11-06T16:18:37.000Z (over 1 year ago)
- Last Synced: 2025-09-04T17:58:50.050Z (10 months ago)
- Topics: fhir, fhir-models
- Language: Ruby
- Homepage:
- Size: 143 MB
- Stars: 88
- Watchers: 14
- Forks: 26
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fhir_models [](https://travis-ci.org/fhir-crucible/fhir_models)
FHIR R4 Resource models generated from FHIR StructureDefinitions.
The StructureDefinitions, XML Schemas, and examples are reused from the [HL7 FHIR build tools](https://github.com/HL7/fhir).
### Getting Started
```
$ bundle install
$ bundle exec rake fhir:console
```
### Features
- FHIR R4 Resource Models
- XML and JSON support
- Resource Validation
- Not Supported
- Primitive Extensions
- FHIR Comments
### Resource Basics
Using XML...
```ruby
xml = File.read('patient-example.xml')
patient = FHIR.from_contents(xml)
puts patient.to_xml
```
Using JSON...
```ruby
json = File.read('patient-example.json')
patient = FHIR.from_contents(json)
puts patient.to_json
```
Creating an `Observation` by hand...
```ruby
obs = FHIR::Observation.new(
'status' => 'final',
'code' => {
'coding' => [{ 'system' => 'http://loinc.org', 'code' => '3141-9', 'display' => 'Weight Measured' }],
'text' => 'Weight Measured'
},
'category' => {
'coding' => [{ 'system' => 'http://hl7.org/fhir/observation-category', 'code' => 'vital-signs' }]
},
'subject' => { 'reference' => 'Patient/example' },
'context' => { 'reference' => 'Encounter/example' }
)
obs.valueQuantity = FHIR::Quantity.new(
'value' => 185,
'unit' => 'lbs',
'code' => '[lb_av]',
'system' => 'http://unitsofmeasure.org'
)
```
Iterating over all elements in a resource, including nested elements...
```ruby
patient.each_element do |value, metadata, path|
puts "Info for #{path}:"
puts "- value: #{value}"
puts "- type: #{metadata['type']}"
puts "- cardinality: #{metadata['min']}..#{metadata['max']}"
end
```
### Validation
Using built in validation...
```ruby
patient.valid? # returns true or false
patient.validate # returns Hash of errors, empty if valid
```
Using a profile or structure definition...
```ruby
sd = FHIR::Definitions.resource_definition('Patient')
sd.validates_resource?(patient) # passing in FHIR::Patient
# Validation failed? Get the errors and warnings...
puts sd.errors
puts sd.warnings
```
# License
Copyright 2014-2021 The MITRE Corporation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.