Resource overview

Almost all overview tabs of any resource can be rendered in your Implementation Guide. StructureDefinitions have their own tree statement for this, other resources use the render statement.

StructureDefinition

The recommended way to reference reesources is by their Canonical, this will ensure that the links will keep working when the guide is exported or duplicated. It is possible to link to resources by their filepath, but this is not recommended.

For the Canonical example we'll use the US Core patient. Note that the scope for this Help section is set to the latest release of the US Core package.

Differential

Example based on canonical referene:

Command 'tree' could not render: File was not found for 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient'

The exact same parameters can be used for rendering by canonical:

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
activeΣ ?!0..1boolean
nameΣ0..*HumanName
telecomΣ I0..*ContactPoint
genderΣ0..1codeBinding
birthDateΣ0..1date
deceasedBooleanboolean
deceasedDateTimedateTime
addressΣ0..*Address
maritalStatus0..1CodeableConceptBinding
multipleBirthBooleanboolean
multipleBirthIntegerinteger
photoI0..*Attachment
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationship0..*CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
gender0..1codeBinding
organizationI0..1Reference(Organization)
periodI0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
language1..1CodeableConceptBinding
preferred0..1boolean
generalPractitionerI0..*Reference(Organization | Practitioner | PractitionerRole)
managingOrganizationΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
otherΣ I1..1Reference(Patient | RelatedPerson)
typeΣ1..1codeBinding

Below we'll only continue to show the file example.

Hybrid

Command 'tree' could not render: File was not found for 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient'

Snapshot (default)

Command 'tree' could not render: File was not found for 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient'

Example resources.

The recommended way to link to other resources is by resource id. This will ensure that the links will keep working even when the guide is exported or duplicated. The rendering will work with Link, xml and json:

{ {Link/xml/json: ResourceType/id}} (without the space between the curly brackets)

For example

Command 'link' could not render: Object reference not set to an instance of an object.

Or the json rendering of the example resource:

Command 'json' could not render: File was not found for Patient/child-example