Resource - FHIR V5.0.0-cibuild - FHIR Build

2.1.29.4.2 Boundaries and Relationships

The following optional elements and properties are defined for all resources:

• An identity
• Meta data
• A base language
• A reference to "Implicit Rules"

Resource is the ancestor of DomainResource from which most recources are derived. Bundle, Parameters, and Binary extend Resource directly.

Note: there is documentation for the Structure, UML, XML, and JSON representations of the resource structure.

2.1.29.4.2.1 Additional Resources defined Outside This Specification

This specification defines the base 126 resources that comprise the "FHIR resources". Additional resources may be defined in other specifications, and used as part of the FHIR framework. For those implementers who wish to use other resources, or find that they need to, the following rules apply:

• Additional Resources to be used like this SHALL be registered with HL7
• Unapproved resources SHALL NOT be used
• Registered and approved resources are given a name by HL7, and this is the name that must be used for the resource
• All such registered and approved resources SHALL have a publicly available definition using a StructureDefinition published as part of an ImplementationGuide, published at the canonical URL. Note that the definitions will be reviewed for quality by HL7 prior to approval

HL7 publishes the list of approved resource at (somewhere?) (todo: this needs further work, but at this time the functional list is published here: IG Registry ). If you wish to register such a resource, the process starts by making a proposal here .

These sections contain information about how additional resources work in the various places that they may be encountered through this specification:

• JSON representation
• XML representation
• Defining Additional Resources
• Bundle.entry
• CapabilityStatement.rest.resource
• DomainResource.contained
• Parameters.parameter.resource

2.1.29.4.2.2 Moving Additional Resources to FHIR Core

Additional resources are all expected to eventually migrate to this specification once they are stable.

Generally, the process for moving an Additional Resource to core is:

• The responsible WG/WGs need to request moving into core.
• FMG needs to approve moving into core (criteria TBD by FMG).
• The resource will be added to the next ballot of FHIR core.
• The resource will be officially available when the milestone release that includes it is published.
• Concurrently with that FHIR Core publication, the status of the 'additional' definition should be updated so that it is deprecated and then eventually removed
• Once the resource has been moved to core, the resourceDefinition element defined for XML and JSON is allowed to remain present, but SHOULD NOT be added. If it is present, the version SHALL be correct with regards to the published core FHIR version