Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updates to Bingings tab based on https://chat.fhir.org/#narrow/stream/179252-IG-creation/topic/Spreadsheet.20authoring.20questions/near/186223890

The content for this page will eventually be migrated from http://wiki.hl7.org/index.php?title=FHIR_Spreadsheet_Authoring

This page describes the process for making use of Excel (or OpenOffice) spreadsheets to design and maintain FHIR data types, resources and profiles. If you haven't already, please read FHIR Guide to Authoring Resources or FHIR_Spreadsheet_Profile_Authoring for important contextual information on how to set up the build environment to make use of the spreadsheet you're about to edit, where to find the appropriate template, etc.

...

A single set of documentation has been provided because most of the tabs and columns are identical regardless of what type of artifact is being created or maintained. Where the rules don't apply everywhere, this page will flag the rule as Resource/Data Type-only or Profile-only.

Contents

Table of Contents
minLevel2

...

  • Binding Name: required - a string beginning with an Uppercase letter. Must be unique across the FHIR specification
  • Definition: required - a string explaining the purpose of this binding. Guides other developers in whether to re-use this binding. Also displayed in the spec.
  • Binding, a choice. Allowed values are:
    • "code list" - an internal reference to a different tab, which enumerates a simple list of codes
    • "value set" - the name of a file in the same directory as the spreadsheet that has the value set for the attribute
    • "reference" - a direct reference to an external standard (usually an RFC) (not bound to schema. typical examples: language, mime type)
    • "special" - used for infrastructural things by the project team. (usually bound to schema)
    • "unbound" - This should only be used when example codes from an external terminology do not exist and none of the others apply. (This should be VERY rare.)
  • Example (Resource-only) - to indicate the the value set binding is an example. Default is 'N'. Only used with "value set" bindings
    • valid values "Y" or "N"
  • Conformance (Profile-only) - Indicates whether the specified codes must be used. Choices are:
    • "required" - systems SHALL use the codes specified
    • "extensible" - systems SHALL use the codes specified if applicable
    • "preferred" - systems SHOULD use the codes specified
    • "example" - systems MAY use the codes specified
    Extensible
  • max-valueset (Profile-only) - If 'Y', indicates that additional codes may be used if no appropriate code is in the specified set. If 'N', indicates that only the specified codes may be used (if the system chooses to adhere to the specified value set) The maximum allowable value set, for use when the binding strength is 'extensible' or 'preferred'
  • Reference, a string - either #[tab-name], or [valueset-file-name] or [http url] - use depends on the binding column
  • Description, a string only used when the Binding is a "reference". It provides the descriptive text used for the URL present in the Reference column
  • OID: Optional - only for code lists. The OID to use for the code list if the FHIR generation process shouldn't assign one
  • URI: Optional - only for code lists. The URI to use for the code list if the FHIR generation process shouldn't assign one
  • Website/Email: Optional - only for code lists. The contact information to use for the code list if the default HL7 information shouldn't be used
  • Copyright: Optional - only for code lists. The copyright information if the default HL7 "public domain" copyright shouldn't be used
  • 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
  • Committee Notes - Additional notes about the selected set of codes - not published

...