This page is part of the CH IG (R4) (v1.2.3: STU) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Guidance

✂️ Best practice: Keep a Guidance page but replace this informative content with your own IG-specific guidance ✂️

For IG authors, the Guidance for FHIR IG Creation provides comprehensive best practices for implementation guide development.

Styles for Narrative

There are defined styles:

• stu-note (see the Home page)
• dragon (see below)
• etc

Instance Fragments

You can embed instance fragments within a page:

{
  "resourceType" : "Patient",
  "id" : "PetraMeier",
  "meta" : {
    "profile" : [
      🔗 "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient"
    ]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Patient PetraMeier</b></p><a name=\"PetraMeier\"> </a><a name=\"hcPetraMeier\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"http://fhir.ch/ig/ch-core/6.0.0-ballot/StructureDefinition-ch-core-patient.html\">CH Core Patient</a></p></div><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">Petra Meier  (no stated gender), DoB Unknown</p><hr/></div>"
  },
  "name" : [
    {
      "family" : "Meier",
      "given" : [
        "Petra"
      ]
    }
  ]
}

Creating Diagrams

• Class Diagrams
• Mermaid
• PlantUml (see example from CH Core below)

Multi-Language Support

• Zulip Channel Multi-lingual IGs
• Producing Multi-Language IGs

TODO

Cross-Versioning

See details about extensions for converting between versions (see also FHIR Cross-Version Mapping Pack).

CH IG example using a backport extension: Cross-Version Encounter R4:

<Encounter xmlns="http://hl7.org/fhir">
  <id value="xver-encounter-r4"/>
  ...
  <extension
             url="http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.subjectStatus">
    <valueCodeableConcept>
      <coding>
        <system
                value="http://terminology.hl7.org/CodeSystem/research-subject-state"/>
        <code value="follow-up"/>
        <display value="Follow-up"/>
      </coding>
      <text value="Follow-up"/>
    </valueCodeableConcept>
  </extension>
  ...
</Encounter>

CH IG profile using a backport extension: CH IG Encounter

Guidelines HL7 Switzerland

• Guidelines for Swiss IG Development
• HL7.ch FHIR IG Balloting
• HL7 Switzerland IG template for IG Publisher: propose a change-link, logos, css adjustments