| Package | hl7.fhir.uv.howto |
| Resource Type | ImplementationGuide |
| Id | hl7.fhir.uv.howto |
| FHIR Version | R5 |
| Source | http://hl7.org/fhir/uv/howto/https://build.fhir.org/ig/FHIR/ig-guidance/index.html |
| URL | http://hl7.org/fhir/uv/howto/ImplementationGuide/hl7.fhir.uv.howto |
| Version | 0.1.0 |
| Status | draft |
| Date | 2025-07-11T21:29:56+00:00 |
| Name | HowToCreateIGs |
| Title | Guidance for FHIR IG Creation |
| Realm | uv |
| Authority | hl7 |
| Description | Provides guidance on the process to define implementation guides using the HL7 IG Publisher and HL7-managed IG templates. It also provides guidance on 'best practices' around IG development and information about how to develop and maintain IG templates. |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ImplementationGuide hl7.fhir.uv.howto
The official URL for this implementation guide is:
http://hl7.org/fhir/uv/howto/ImplementationGuide/hl7.fhir.uv.howto
Provides guidance on the process to define implementation guides using the HL7 IG Publisher and HL7-managed IG templates. It also provides guidance on 'best practices' around IG development and information about how to develop and maintain IG templates.
FHIR{
"resourceType": "ImplementationGuide",
"id": "hl7.fhir.uv.howto",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.org/fhir/uv/howto/ImplementationGuide/hl7.fhir.uv.howto",
"version": "0.1.0",
"name": "HowToCreateIGs",
"title": "Guidance for FHIR IG Creation",
"status": "draft",
"experimental": false,
"date": "2025-07-11T21:29:56+00:00",
"publisher": "HL7 International - FHIR Management Group",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/Special/committees/fhirmg"
}
]
}
],
"description": "Provides guidance on the process to define implementation guides using the HL7 IG Publisher and HL7-managed IG templates. It also provides guidance on 'best practices' around IG development and information about how to develop and maintain IG templates.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"packageId": "hl7.fhir.uv.howto",
"license": "CC0-1.0",
"fhirVersion": [
"5.0.0"
],
"dependsOn": [
{
"id": "hl7tx",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on HL7 Terminology"
}
],
"uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
"packageId": "hl7.terminology.r5",
"version": "6.5.0"
},
{
"id": "hl7ext",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on the HL7 Extension Pack"
}
],
"uri": "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions",
"packageId": "hl7.fhir.uv.extensions.r5",
"version": "5.2.0"
}
],
"definition": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency",
"valueCode": "hl7.fhir.uv.tools.r5#0.5.0"
}
],
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Patient"
}
],
"reference": {
"reference": "Patient/example"
},
"name": "Example patient",
"description": "Example used to show the use of instance fragments"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Bundle"
}
],
"reference": {
"reference": "Bundle/sign-xml"
},
"name": "null (Bundle)"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Bundle"
}
],
"reference": {
"reference": "Bundle/signed"
},
"name": "null (Bundle)"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ConceptMap"
}
],
"reference": {
"reference": "ConceptMap/map-logical-patient"
},
"name": "LogicalPatientMap"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:logical"
}
],
"reference": {
"reference": "StructureDefinition/test-logical-patient"
},
"name": "LogicalPatient"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/test-patient-profile"
},
"name": "TestPatientProfile"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Encounter"
}
],
"reference": {
"reference": "Encounter/1"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Encounter"
}
],
"reference": {
"reference": "Encounter/2"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Encounter"
}
],
"reference": {
"reference": "Encounter/3"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Encounter"
}
],
"reference": {
"reference": "Encounter/4"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "MedicationStatement"
}
],
"reference": {
"reference": "MedicationStatement/68d6febd-05cf-4617-81aa-2ba187ff0118"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "MedicationStatement"
}
],
"reference": {
"reference": "MedicationStatement/d03a9e35-57eb-4459-8e40-f45fcf33e90d"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "MedicationStatement"
}
],
"reference": {
"reference": "MedicationStatement/19cdc532-89ef-4416-b91e-b51386d57189"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Observation"
}
],
"reference": {
"reference": "Observation/5c755360-3535-484e-8236-73a903b07191"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Observation"
}
],
"reference": {
"reference": "Observation/0443e759-8923-4450-ac1b-5a070ee291c0"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Observation"
}
],
"reference": {
"reference": "Observation/48f4cd41-5259-4217-9a25-2c30bf9f5edd"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Observation"
}
],
"reference": {
"reference": "Observation/9589661c-b8e7-4fee-8107-ea68601d2d76"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Observation"
}
],
"reference": {
"reference": "Observation/286f81a0-a674-4271-ab0b-6e3f0b11af21"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Observation"
}
],
"reference": {
"reference": "Observation/97aa2552-119f-470d-b4cc-bba7e3825a9e"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Observation"
}
],
"reference": {
"reference": "Observation/8f3a09f3-556b-47f1-aab8-9840d22036e4"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Observation"
}
],
"reference": {
"reference": "Observation/8016b150-e810-468e-9789-996aae94b395"
}
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Patient"
}
],
"reference": {
"reference": "Patient/47234"
},
"name": "Example Patient - 47234",
"profile": [
"http://hl7.org/fhir/uv/howto/StructureDefinition/test-patient-profile"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Patient"
}
],
"reference": {
"reference": "Patient/689272"
},
"name": "Example Patient - 689272",
"profile": [
"http://hl7.org/fhir/uv/howto/StructureDefinition/test-patient-profile"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Patient"
}
],
"reference": {
"reference": "Patient/2451"
},
"name": "Example Patient - 2451",
"profile": [
"http://hl7.org/fhir/uv/howto/StructureDefinition/test-patient-profile"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Patient"
}
],
"reference": {
"reference": "Patient/562"
},
"name": "Example Patient - 562",
"profile": [
"http://hl7.org/fhir/uv/howto/StructureDefinition/test-patient-profile"
]
}
],
"page": {
"sourceUrl": "toc.html",
"name": "toc.html",
"title": "Table of Contents",
"generation": "html",
"page": [
{
"sourceUrl": "index.html",
"name": "index.html",
"title": "IG Home Page",
"generation": "html"
},
{
"sourceUrl": "background.html",
"name": "background.html",
"title": "Background",
"generation": "html"
},
{
"sourceUrl": "readingIgs.html",
"name": "readingIgs.html",
"title": "Reading Implemenation Guides",
"generation": "html"
},
{
"sourceUrl": "best-practice.html",
"name": "best-practice.html",
"title": "IG Best Practices",
"generation": "markdown"
},
{
"sourceUrl": "pinning.html",
"name": "pinning.html",
"title": "Managing Canonical Versions (pinning)",
"generation": "markdown"
},
{
"sourceUrl": "terminology.html",
"name": "terminology.html",
"title": "Working with Terminology",
"generation": "html"
},
{
"sourceUrl": "sql.html",
"name": "sql.html",
"title": "Working with SQL",
"generation": "html"
},
{
"sourceUrl": "jsonxml.html",
"name": "jsonxml.html",
"title": "Presenting JSON and XML files",
"generation": "html"
},
{
"sourceUrl": "fragments.html",
"name": "fragments.html",
"title": "Using Instance Fragments",
"generation": "html"
},
{
"sourceUrl": "uml.html",
"name": "uml.html",
"title": "Creating Class Diagrams",
"generation": "markdown"
},
{
"sourceUrl": "languages.html",
"name": "languages.html",
"title": "Producing Multi-Language IGs",
"generation": "markdown"
},
{
"sourceUrl": "maturityprop.html",
"name": "maturityprop.html",
"title": "Maturity Propagation",
"generation": "html"
},
{
"sourceUrl": "tooling.html",
"name": "tooling.html",
"title": "IG Tooling",
"generation": "html"
},
{
"sourceUrl": "related-igs.html",
"name": "related-igs.html",
"title": "Related IGs",
"generation": "markdown"
},
{
"sourceUrl": "using-templates.html",
"name": "using-templates.html",
"title": "Using the HL7 Templates",
"generation": "html"
},
{
"sourceUrl": "diagrams-plantuml.html",
"name": "diagrams-plantuml.html",
"title": "Adding diagrams (PlantUml)",
"generation": "markdown"
},
{
"sourceUrl": "diagrams-mermaid.html",
"name": "diagrams-mermaid.html",
"title": "Adding diagrams (Mermaid)",
"generation": "markdown"
},
{
"sourceUrl": "testing.html",
"name": "testing.html",
"title": "Testing Support",
"generation": "markdown",
"page": [
{
"sourceUrl": "testfactory.html",
"name": "testfactory.html",
"title": "Working with Test Data Factories",
"generation": "markdown"
},
{
"sourceUrl": "matchetypes.html",
"name": "matchetypes.html",
"title": "Using Matchetypes",
"generation": "markdown"
},
{
"sourceUrl": "profile-test-cases.html",
"name": "profile-test-cases.html",
"title": "Profile Test Cases",
"generation": "markdown"
}
]
},
{
"sourceUrl": "multi-maps.html",
"name": "multi-maps.html",
"title": "Working with Multiple Maps",
"generation": "markdown"
},
{
"sourceUrl": "vcl.html",
"name": "vcl.html",
"title": "VCL: ValueSet Compose Language",
"generation": "markdown"
},
{
"sourceUrl": "narrative.html",
"name": "narrative.html",
"title": "Rules about Narrative",
"generation": "markdown"
},
{
"sourceUrl": "template.html",
"name": "template.html",
"title": "Extending the HL7 IG Templates",
"generation": "html",
"page": [
{
"sourceUrl": "colors.html",
"name": "colors.html",
"title": "Changing the IG colors",
"generation": "markdown"
}
]
},
{
"sourceUrl": "downloads.html",
"name": "downloads.html",
"title": "Useful Downloads",
"generation": "html"
},
{
"sourceUrl": "changes.html",
"name": "changes.html",
"title": "IG Change History",
"generation": "html"
}
]
},
"parameter": [
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "copyrightyear"
},
"value": "2019+"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "releaselabel"
},
"value": "CI Build"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "globals-in-artifacts"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "viewDefinition"
},
"value": "input/sql/sql-view-valueset.json"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "test-data-factories"
},
"value": "factories/factories.json"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-factory"
},
"value": "input/factories"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "suppress-mappings"
},
"value": "*"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "autoload-resources"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/capabilities"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/examples"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/extensions"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/models"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/operations"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/profiles"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/resources"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/vocabulary"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/maps"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/testing"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/history"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "fsh-generated/resources"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-pages"
},
"value": "template/config"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-pages"
},
"value": "input/images"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-liquid"
},
"value": "template/liquid"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-liquid"
},
"value": "input/liquid"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-qa"
},
"value": "temp/qa"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-temp"
},
"value": "temp/pages"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-output"
},
"value": "output"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-tx-cache"
},
"value": "input-cache/txcache"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-suppressed-warnings"
},
"value": "input/ignoreWarnings.txt"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-history"
},
"value": "http://hl7.org/fhir/uv/howto/history.html"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "template-html"
},
"value": "template-page.html"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "template-md"
},
"value": "template-page-md.html"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-contact"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-context"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-copyright"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-jurisdiction"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-license"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-publisher"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-version"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-wg"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "active-tables"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "fmm-definition"
},
"value": "http://hl7.org/fhir/versions.html#maturity"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "propagate-status"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "excludelogbinaryformat"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "tabbed-snapshots"
},
"value": "true"
}
]
}
}