Difference between revisions of "FHIR Guide to Authoring Resources"

Latest revision as of 15:41, 30 October 2019

Content on this page has been migrated to Confluence here: https://confluence.hl7.org/display/FHIR/Resource+Authoring

Back to FHIR

Back to FHIR discussions / active discussions

This page contains discussion about issues and considerations related to HL7's FHIR specification. When adding content to a page, be sure to uncomment the "Active" category if it is commented (surrounded by ) so that others can notice it and participate too.

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.

@@ Line 1: / Line 1: @@
-{{FHIR Discussion Page}}
+Content on this page has been migrated to Confluence here: <nowiki>https://confluence.hl7.org/display/FHIR/Resource+Authoring</nowiki>
+<br />{{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.
-<b>Note: before attempting to author resources, you MUST be able to successfully [[FHIR Build Process|run the FHIR build process]].</b>
+<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 camel case name [name], and an upper camel-case name [Name]. Each resource has a sub-directory [name] in the source folder of the FHIR svn hierarchy, which contains all the files related to the resource. The build process looks for the following files:
+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
-* several xhtml files that allow additional text documentation to be added for 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]-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
+**[name]-introduction.xml - text documentation that goes above the formal resource definition on the resource page
-** others yet to be documented
+**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.
+*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==
@@ Line 23: / Line 24: @@
 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 condident it's your fault . . .)
+#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 /template/template-spreadsheeet.xml to /[name]/[name]-spreadsheet.xml (and open it, and replace "Template" in the first column of the Data Elements tab with [Name])
+#copy templates/template-spreadsheet.xml to [name]/[name]-spreadsheet.xml
-# copy /template/template-html.xml to /[name]/[name]-notes.xml and /[name]/[name]-introduction.xml
+##open it and replace "[ResourceOrDataTypeName]" in the first column of the Data Elements tab with [Name])
-# copy /template/template-example.xml /[name]/[name]-example.xml
+##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 SVN
+#copy templates/template-notes.xml to [name]/[name]-notes.xml
-# edit /fhir.ini
+#copy templates/template-introduction.xml to [name]/[name]-introduction.xml
-## add [name]=[Name] to the [resources] section
+#copy templates/template-example.xml [name]/[name]-example.xml
-## add [name]={desc} to the [status] section. desc is agreed as part of the resource proposal
+#add the new directory and its files to git
-# for some special resources, you may need to register the resource in /navigation.xml. But not for normal resources
+#edit fhir.ini
-# test and make sure the build completes without errors
+##add [name]=[Name] to the [resources] section
-# commit all changes to SVN
+##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]).
-== Excel Spreadsheet ==
+==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.
-The Excel spreadsheet contains the main logical definitions of the resource. In order to support version control, and other forms of text processing, the spreadsheet is stored as an XML document. In Excel, this format is chosen by saving as an XML Spreadsheet 2003. Any other software that can edit this format (i.e. OpenOffice) can also be used.  It's even possible to use a text editor, though this is not recommended. (Note: the project team is not committed to Excel. Alternatives can be considered, as long as the same logical content can be defined).
-The Excel spreadsheet contains the following tabs:
-* Data Elements - defines the actual contents of the resource
-* Invariants - documents additional rules about the resource such as co-occurrence constraints
-* Events - defined messaging events for the resource
-* "Search" - defined search parameters for the restful interface
-* "Examples" - define multiple examples for the resource
-* "Bindings" - vocabulary bindings for the resource contents
-The order of the tabs is not important, and other tabs can be defined. Except as documented below, other tabs are ignored. In addition, for every page, additional columns can be defined at the discretion of the editor; they will be ignored by the build process. Additional rows other than those containing the defined contents cannot be added.
-=== Data Elements Tab ===
-=== Examples Tab ===
-The Examples Tab lists the details for example files for a resource. If the tab does not hold any references to examples,
-the resource's source directory will be search for a file ending in "{resourcename}-example.xml" and this file is then used as an example instead.
-The tab can contain the following columns:
-* "Name", A string, may not be empty.
-* "Identity", a string.
-* "Type", a choice. Allowed values are:
-** (empty) or "xml"
-** "csv"
-** "tool"
-* "Description", a string, may not be empty.
-* "Filename", a string, may not be empty.
-* "In Book", a boolean.
-=== Search Tab ===
-The Search tab contains the search operations for a resource. The standard search operations $page, $count and $id do not need to be specified, but are added automatically.
-The Search Tab has the following columns:
-* "Name", a string. May not end in "-before" or "-after", these suffixes are automatically added for time-based searches.
-* "Description", a string.
-* "Type", a choice. Allowed values are:
-** "integer"
-** "string"
-** "text"
-** "date"
-** "token"
-** "qtoken"
-* "Repeats", a choice. Allowed values are:
-** "single"
-** "union"
-** "intersection"
-=== Bindings Tab ===
-The Binding tab contains the definition of the Bindings as mentioned in the definition of the data elements. The Binding column in the Data Elements Tab refers to the Binding Name.
-This tab contains the following columns:
-* "Binding Name", a string. Must begin with an Uppercase letter
-* "Definition", a string
-* "Binding", a choice. Allowed values are:
-** (empty) or "unbound" - this will be phased out soon
-** "code list" - an internal reference to a different tab, which enumerates a simple list of codes
-** "special" - used for infrastructural things by the project team. (usually bound to schema)
-** "reference" - a direct reference to an external standard (usually an RFC)  (not bound to schema. typical examples: language, mime type)
-** "value set" - the name of a file in the same directory as the spreadsheet that has the value set for the attribute
-* "Example" - to indicate the the value set binding is an example. only used with "value set" bindings
-** valid values "y" or blank
-* "Reference", a string - either #[tab-name], or [valueset-file-name] or [http url] - use depends on the binding column
-* "Description", a string used when the reference is rendered for reference bindings
-* "v2" - the URI of a value set in v2 that the codes are mapped to (binding = code list only). see http://hl7.org/implement/standards/fhir/terminologies-v2.htm for valid values
-* "v3" - the URI of a value set in v3 that the codes are mapped to (binding = code list only). see http://hl7.org/implement/standards/fhir/terminologies-v3.htm for valid values
-Notes:
-* if the data type is "code", you must choose either code list, special, or reference
-** the code choices will be bound by schema. You are allowed to define your own codes in this case, and they are subject to ballot
-* if the data type is "coding" or "codeableConcept" you must choose "code list" or "value set" unless the core project team agrees otherwise (can't think of any cases for this)
-** a code list is just converted in a value set reference - it's a cheap and limited way to do an enumeration. Support for this will be removed in the future.
-** whether you use code list or value set, the value set should consist of codes defined elsewhere. Internal codes should not be defined unless suitable codes don't exist elsewhere, and use cases for this should be discussed with the core project team. In principle, these codes are required to be under either harmonisation or external authority
-In case the Binding is of type "code list", the column "Reference" must contain the name of another tab containing the valueset for this binding, prefixed by '#'. This tab contains the following columns:
-* "Id", a number - used for internal references to create subsumption heirarchies
-* "System", a string - used to refer to codes from external systems (use the URI published in the FHIR ballot. if the URI is not published, consult the core project team)
-** note: provide either an ID or a system, but not both
-* "Code", a string - the code that identifies the concept
-* "Display", a string - do not provide "display" for internal codes that are going to be bound in schema. If the code is external, you *should* provide a display so the publishing tools can publish one for user convenience
-* "Definition", a string - mandatory if the code is an internal code. Recommended if the code is external, so the tools can publish it for use convenience
-* "Comment", a string - optional. usage guidance.
-* "v2" and "v3" - v2 and v3 mappings, if there are mappings defined in the bindings tab (else ignored)
-** the syntax consists of a set of map statements, separated by "," (no spaces)
-** a map statement consists of a single character equivalence, then the table number of code system name, then a ".", and then the code, optionally with a comment in brackets following
-** the equivalent character is "=" - exact. "~" - equivalent. ">" - narrower (i.e. the v2/v3 code is narrower than the FHIR code). "<" - wider
-** e.g. ~0190.H - this code is equivalent to "H" in table 0190
-** e.g. >EntityNameUse.BAD(not sure about old) - this code maps to "BAD" in EntityNameUse, but the definition of "BAD" is narrower. the comment is an explanation of the issue (probably shouldn't be as cryptic as this comment). When you use the equivalence "<", you must make a comment

Difference between revisions of "FHIR Guide to Authoring Resources"

Latest revision as of 15:41, 30 October 2019

Background

Creating a new resource

Editing a FHIR resource

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

groups

meetings

general

Tools