Entity & Attributes and Zen Schema are planned to be retired and will be replaced by FHIR Schema. Here’s a migration guide to help you transition your custom resources defined via Entity & Attributes / Zen Schema.
If you're not familiar with Aidbox Project, read this section first.
Since 2303, Aidbox can be configured to create custom resources by Aidbox Projects.
Create custom resource
To create a custom resource in Aidbox Project you need to:
Create repositories service;
Make a repository, associated with new resource type;
Optionally, create a base profile scheme and associate it with your custom type repository.
Create repository service
Copy repositories
{ :zen/tags #{aidbox/service}
:engine aidbox.repository.v1/engine
:repositories #{our-repository}
:load-default true }
box
{ :zen/tags #{aidbox/system}
:services { :repositories repositories}}} Make a repository
In this example new custom resource have name OurType and will be available by e.g. GET /OurType.
The :base-profile key is optional. If you don't want to validate resource on creating, you may not use it. If not specified, custom resource won't be validated and search won't support this custom type.
Copy our-repository
{:zen/tags #{aidbox.repository.v1/repository}
:resourceType "OurType"
:base-profile OurType
:extra-parameter-sources :all}
Create base profile
The base profile configures validation of the resource. It should be tagged with zen.fhir/base-schema.
Copy OurType
{:zen/tags #{zen/schema zen.fhir/base-schema}
:zen.fhir/type "OurType"
:zen.fhir/version "0.5.11"
:type zen/map
:confirms #{zen.fhir/Resource}
:require #{:name}
:keys {:name {:type zen/vector
:every {:type zen/map
:keys {:given {:type zen/vector
:every {:type zen/string}}
:family {:type zen/string}}}}}} In this example, the OurType schema will be used to validate OurType resource, requiring name field. We also define a structure of a name: it must be vector, every element can contain given or family fields.
Full example configuration
Copy {ns main
import #{aidbox.index.v1
aidbox.search-parameter.v1
aidbox
aidbox.repository.v1
zen.fhir}
OurType
{:zen/tags #{zen/schema zen.fhir/base-schema}
:zen.fhir/type "OurType"
:zen.fhir/version "0.5.11"
:type zen/map
:require #{:name}
:confirms #{zen.fhir/Resource}
:keys {:resourceType {:const {:value "OurType"}
:type zen/string}
:name {:type zen/vector
:every {:type zen/map
:keys {:given {:type zen/vector
:every {:type zen/string}}
:family {:type zen/string}}}}}}
our-repository
{:zen/tags #{aidbox.repository.v1/repository}
:resourceType "OurType"
:base-profile OurType
:extra-parameter-sources :all}
repositories
{:zen/tags #{aidbox/service}
:engine aidbox.repository.v1/engine
:repositories #{our-repository}
:load-default true}
box
{:zen/tags #{aidbox/system}
:services {:repositories repositories}}}
Examples
Copy {ns main
import #{aidbox.index.v1
aidbox.search-parameter.v1
aidbox
aidbox.repository.v1
zen.fhir}
Resource
{:zen/tags #{zen/schema zen.fhir/structure-schema}
:type zen/map
:zen.fhir/version "0.5.11"
:keys {:id {:type zen/string}
:resourceType {:type zen/string}
:meta {:type zen/map
:keys {:profile {:type zen/vector
:every {:type zen/string}}
:lastUpdated {:type zen/datetime}}}}}
OurType
{:zen/tags #{zen/schema zen.fhir/base-schema}
:confirms #{Resource}
:zen.fhir/type "OurType"
:zen.fhir/version "0.5.11"
:type zen/map
:require #{:name},
:keys {:resourceType {:const {:value "OurType"}}
:mydate {:type zen/string
:zen.fhir/type "date"
:regex "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$"}
:mynumber {:type zen/number
:zen.fhir/type "integer"}
:active {:type zen/boolean
:zen.fhir/type "boolean"}
:myreference {:confirms #{zen.fhir/Reference}
:zen.fhir/type "Reference"
; MyType, MyType2 are also base-profile schemas
; for custom repositories
:zen.fhir/reference {:refers #{MyType MyType2}}}
:myquantity {:zen.fhir/type "Quantity"
:type zen/map
:keys {:value {:type zen/number}
:code {:type zen/string}
:system {:type zen/string}}}
:myuri {:zen.fhir/type "uri"
:type zen/string}
:name {:type zen/vector
:every {:type zen/map
:keys {:given {:type zen/vector
:every {:type zen/string}}
:family {:type zen/string}}}}}}
our-param-reference
{:zen/tags #{aidbox.search-parameter.v1/search-parameter}
:name "reference"
:type :reference
:resource {:resourceType "Entity" :id "OurType"}
:expression [["myreference"]]}
our-param-string
{:zen/tags #{aidbox.search-parameter.v1/search-parameter}
:name "string"
:type :string
:resource {:resourceType "Entity" :id "OurType"}
:expression [["name" "given"] ["name" "family"]]}
our-param-date
{:zen/tags #{aidbox.search-parameter.v1/search-parameter}
:name "date"
:type :date
:resource {:resourceType "Entity" :id "OurType"}
:expression [["mydate"]]}
our-param-number
{:zen/tags #{aidbox.search-parameter.v1/search-parameter}
:name "number"
:type :number
:resource {:resourceType "Entity" :id "OurType"}
:expression [["mynumber"]]}
our-param-token
{:zen/tags #{aidbox.search-parameter.v1/search-parameter}
:name "token"
:type :token
:resource {:resourceType "Entity" :id "OurType"}
:expression [["active"]]}
our-param-quantity
{:zen/tags #{aidbox.search-parameter.v1/search-parameter}
:name "quantity"
:type :quantity
:resource {:resourceType "Entity" :id "OurType"}
:expression [["myquantity"]]}
our-param-uri
{:zen/tags #{aidbox.search-parameter.v1/search-parameter}
:name "uri"
:type :uri
:resource {:resourceType "Entity" :id "OurType"}
:expression [["myuri"]]}
our-repository
{:zen/tags #{aidbox.repository.v1/repository}
:resourceType "OurType"
:base-profile OurType
:extra-parameter-sources :all
:search-parameters #{our-param-string
our-param-date
our-param-reference
our-param-number
our-param-token
our-param-uri
our-param-quantity}}
repositories
{:zen/tags #{aidbox/service}
:engine aidbox.repository.v1/engine
:repositories #{our-repository mytype-repository mytype2-repository}
:load-default true}
box {:zen/tags #{aidbox/system}
:services
{:repositories repositories}}}
Copy {ns main
import #{aidbox.index.v1
aidbox.search-parameter.v1
aidbox.search-parameter.draft
aidbox
aidbox.repository.v1
hl7-fhir-us-core.us-core-patient
hl7-fhir-r4-core.string
zen.fhir
awf.task
awf.executor}
patient
{:zen/tags #{zen/schema zen.fhir/nested-schema}
:type zen/map
:zen.fhir/type "Patient"
:zen.fhir/version "0.5.11"
:confirms #{hl7-fhir-us-core.us-core-patient/schema}
:keys {:name {:type zen/vector
:every {:type zen/map
:keys {:otherName
{:confirms #{hl7-fhir-r4-core.string/schema}
:fhir/extensionUri "http://someurl/r4/StructureDefinition/Patient-name-otherName"}}}}
:someField {:confirms #{hl7-fhir-r4-core.string/schema}
:fhir/extensionUri "http://someurl/r4/StructureDefinition/Patient-someField"}}}
patient-repository
{:zen/tags #{aidbox.repository.v1/repository}
:resourceType "Patient"
:base-profile patient
:indexes #{}
:extra-parameter-sources :all
:search-parameters #{my-parameter}}
repositories
{:zen/tags #{aidbox/service}
:engine aidbox.repository.v1/engine
:repositories #{patient-repository}
:load-default true}
box {:zen/tags #{aidbox/system}
:services
{:repositories repositories
:task-service awf.task/task-service
:task-executor aidbox/aidbox-long-pool-executor-service
:decisions-executor aidbox/aidbox-decisions-pool-executor-service}}} 