This wiki has undergone a migration to Confluence found Here
Difference between revisions of "FHIR Guide to Authoring Resources"
Jump to navigation
Jump to search
Ewoutkramer (talk | contribs) |
Bryn rhodes (talk | contribs) |
||
| (37 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{FHIR Discussion Page}} | ||
| + | [[Category:Active FHIR Discussion]] | ||
| + | |||
This is the technical documentation that describes what you do to author a resource that will be part of the FHIR specification. There is a also a [[FHIR Guide to Designing Resources|Design Guide]] that addresses how resources should be designed. | This is the technical documentation that describes what you do to author a resource that will be part of the FHIR specification. There is a also a [[FHIR Guide to Designing Resources|Design Guide]] that addresses how resources should be designed. | ||
| − | Note: before attempting to author resources, you | + | <b>Note: before attempting to author resources, you MUST be able to successfully [[FHIR Build Process|run the FHIR build process]]. You must also sign up to the FHIR Committers Zulip chat at https://chat.fhir.org/#narrow/stream/committers |
== Background == | == Background == | ||
| − | All FHIR resources have both a lower | + | All FHIR resources have both a lower case name [name], and a Pascal-case name [Name]. For example, for the StructureDefinition resource, the lower case name is structuredefinition and the Pascal-case name is StructureDefinition. Each resource has a sub-directory [name] in the source folder of the FHIR git repository, which contains all the files related to the resource. The build process looks for the following files: |
* an excel spreadsheet [name]-spreadsheet.xml that defines the content and behavior of the resource | * an excel spreadsheet [name]-spreadsheet.xml that defines the content and behavior of the resource | ||
| Line 14: | Line 17: | ||
* one or more [name]-(whatever)-example.xml which is an example of the resource (refer to [[#Example Elements Tab]] for guidance on naming example files. | * one or more [name]-(whatever)-example.xml which is an example of the resource (refer to [[#Example Elements Tab]] for guidance on naming example files. | ||
| − | Only the first file must exist, though at least one example must exist. Managing examples is discussed further below. | + | Only the first file must exist, though at least one example must exist. Managing examples is discussed further below. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Creating a new resource== | ==Creating a new resource== | ||
| Line 33: | Line 23: | ||
Creating a new resource is only done by the FHIR project team once a new resource has been proposed and accepted. This section documents the process that the project team follows. paths are relative to the source directory. | Creating a new resource is only done by the FHIR project team once a new resource has been proposed and accepted. This section documents the process that the project team follows. paths are relative to the source directory. | ||
| − | # test and make sure your local copy of the build process completes without errors (so that if something breaks, you can be | + | # test and make sure your local copy of the build process completes without errors (so that if something breaks, you can be confident it's your fault . . .) |
# create the directory [name] in the source directory | # create the directory [name] in the source directory | ||
| − | # copy | + | # copy templates/template-spreadsheet.xml to [name]/[name]-spreadsheet.xml |
| − | # copy | + | ## open it and replace "[ResourceOrDataTypeName]" in the first column of the Data Elements tab with [Name]) |
| − | # copy | + | ## select an appropriate w5 category (e.g. clinical.general) (see source/w5.ini for a list of categories) |
| − | # add the new directory and its files to | + | # copy templates/template-notes.xml to [name]/[name]-notes.xml |
| − | # edit | + | # copy templates/template-introduction.xml to [name]/[name]-introduction.xml |
| + | # copy templates/template-example.xml [name]/[name]-example.xml | ||
| + | # add the new directory and its files to git | ||
| + | # edit fhir.ini | ||
## add [name]=[Name] to the [resources] section | ## add [name]=[Name] to the [resources] section | ||
| − | ## add [name]= | + | ## add [name]=committee to workgroups section |
| − | # | + | ## add [name]=0 to fmm section |
| + | ## add [Name]=tla the tlas section | ||
| + | # edit heirarchy.xml and add your page under the correct place within the site's navigation | ||
| + | # open compartments.xml with Excel and specify which search parameters can be used to place the resource in a Patient or Practitioner compartment (or leave empty if N/A) | ||
| + | # if your resource has an element named "status", open status-codes.xml with Excel and add the appropriate mappings to the status. Use other resources in the same category (definition, request, event) as a pattern for the mappings. | ||
| + | # add your resource to resourcelist.html and /resourceguide.html (both in the right category and under the right caption letter) | ||
| + | # add your resource as appropriate in source/administration-module.html, source/clinicalreasoning-module.html, source/clinicalsummary-module.html, source/conformance-module.html, source/diagnostics-module.html, source/financial-module.html, source/foundation-module.html, source/implsupport-module.html, source/medication-module.html, source/ontology-module.html, source/secpriv-module.html, source/terminology-module.html, and/or source/workflow-module.html | ||
| + | # add a translation for your resources name to implementations/translations.xml | ||
| + | # edit the example to fill out the [Name] on the base node and add a <id value="xxx"/> where xxx is what you're going to call the example (usually "example") | ||
# test and make sure the build completes without errors | # test and make sure the build completes without errors | ||
| − | # commit all changes to | + | # commit all changes to a git branch, push to GitHub, and create a Pull Request (see https://github.com/hl7/fhir/wiki/Get-Started-with-FHIR-on-GitHub]). |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | == Editing a FHIR resource== | |
| − | + | Instructions for how to make use of the FHIR resource spreadsheet can be found [[FHIR Spreadsheet Authoring | here]]. Instructions on using the notes and introduction HTML pages are embedded as comments within the XHTML templates. If you run into issues, ask a question on the FHIR Committers list. | |
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 22:16, 26 September 2018
This is the technical documentation that describes what you do to author a resource that will be part of the FHIR specification. There is a also a Design Guide that addresses how resources should be designed.
Note: before attempting to author resources, you MUST be able to successfully run the FHIR build process. You must also sign up to the FHIR Committers Zulip chat at https://chat.fhir.org/#narrow/stream/committers
Background
All FHIR resources have both a lower case name [name], and a Pascal-case name [Name]. For example, for the StructureDefinition resource, the lower case name is structuredefinition and the Pascal-case name is StructureDefinition. Each resource has a sub-directory [name] in the source folder of the FHIR git repository, which contains all the files related to the resource. The build process looks for the following files:
- an excel spreadsheet [name]-spreadsheet.xml that defines the content and behavior of the resource
- several xhtml files that allow additional text documentation to be added for the resource
- [name]-notes.xml - text documentation that goes below the formal resource definition on the resource page
- [name]-introduction.xml - text documentation that goes above the formal resource definition on the resource page
- others yet to be documented
- one or more [name]-(whatever)-example.xml which is an example of the resource (refer to #Example Elements Tab for guidance on naming example files.
Only the first file must exist, though at least one example must exist. Managing examples is discussed further below.
Creating a new resource
Creating a new resource is only done by the FHIR project team once a new resource has been proposed and accepted. This section documents the process that the project team follows. paths are relative to the source directory.
- test and make sure your local copy of the build process completes without errors (so that if something breaks, you can be confident it's your fault . . .)
- create the directory [name] in the source directory
- copy templates/template-spreadsheet.xml to [name]/[name]-spreadsheet.xml
- open it and replace "[ResourceOrDataTypeName]" in the first column of the Data Elements tab with [Name])
- select an appropriate w5 category (e.g. clinical.general) (see source/w5.ini for a list of categories)
- copy templates/template-notes.xml to [name]/[name]-notes.xml
- copy templates/template-introduction.xml to [name]/[name]-introduction.xml
- copy templates/template-example.xml [name]/[name]-example.xml
- add the new directory and its files to git
- edit fhir.ini
- add [name]=[Name] to the [resources] section
- add [name]=committee to workgroups section
- add [name]=0 to fmm section
- add [Name]=tla the tlas section
- edit heirarchy.xml and add your page under the correct place within the site's navigation
- open compartments.xml with Excel and specify which search parameters can be used to place the resource in a Patient or Practitioner compartment (or leave empty if N/A)
- if your resource has an element named "status", open status-codes.xml with Excel and add the appropriate mappings to the status. Use other resources in the same category (definition, request, event) as a pattern for the mappings.
- add your resource to resourcelist.html and /resourceguide.html (both in the right category and under the right caption letter)
- add your resource as appropriate in source/administration-module.html, source/clinicalreasoning-module.html, source/clinicalsummary-module.html, source/conformance-module.html, source/diagnostics-module.html, source/financial-module.html, source/foundation-module.html, source/implsupport-module.html, source/medication-module.html, source/ontology-module.html, source/secpriv-module.html, source/terminology-module.html, and/or source/workflow-module.html
- add a translation for your resources name to implementations/translations.xml
- edit the example to fill out the [Name] on the base node and add a <id value="xxx"/> where xxx is what you're going to call the example (usually "example")
- test and make sure the build completes without errors
- commit all changes to a git branch, push to GitHub, and create a Pull Request (see https://github.com/hl7/fhir/wiki/Get-Started-with-FHIR-on-GitHub]).
Editing a FHIR resource
Instructions for how to make use of the FHIR resource spreadsheet can be found here. Instructions on using the notes and introduction HTML pages are embedded as comments within the XHTML templates. If you run into issues, ask a question on the FHIR Committers list.
