{
"description": "The FHIR for FAIR - FHIR Implementation Guide aims to provide guidance on how HL7 FHIR can be used for supporting FAIR health data implementation and assessment.",
"_filename": "ImplementationGuide-hl7.fhir.uv.fhir-for-fair.json",
"package_name": "hl7.fhir.uv.fhir-for-fair",
"definition": {
"page": {
"page": [ {
"title": "FHIR for FAIR Home Page",
"nameUrl": "index.html",
"generation": "markdown"
}, {
"title": "About this version",
"nameUrl": "aboutThisVersion.html",
"generation": "markdown"
}, {
"title": "Overview",
"nameUrl": "rw-overview.html",
"generation": "markdown"
}, {
"title": "General Recommendations",
"nameUrl": "recommendations.html",
"generation": "markdown"
}, {
"title": "Immunology Database and Analysis Portal",
"nameUrl": "immPort.html",
"generation": "markdown"
}, {
"title": "FAIR4Health Project",
"nameUrl": "FAIR4Health.html",
"generation": "markdown"
}, {
"title": "Leipzig Health Atlas (LHA)",
"nameUrl": "leipzigHealthAtlas.html",
"generation": "markdown"
}, {
"title": "Terminologies",
"nameUrl": "terminology.html",
"generation": "markdown"
}, {
"title": "Implementing the RDA Indicators",
"nameUrl": "FHIRandRDAMetrics.html",
"generation": "markdown"
}, {
"title": "RDA Indicators",
"nameUrl": "RDAMetrics.html",
"generation": "markdown"
}, {
"title": "Methodology",
"nameUrl": "methodology.html",
"generation": "markdown"
}, {
"title": "Deployments",
"nameUrl": "deployment.html",
"generation": "markdown"
}, {
"title": "Metadata and data",
"nameUrl": "metadata.html",
"generation": "markdown"
}, {
"title": "FAIR Guiding Principles",
"nameUrl": "FAIR.html",
"generation": "markdown"
}, {
"title": "Representing FAIR metadata with Citation",
"nameUrl": "citation.html",
"generation": "markdown"
}, {
"title": "Implementing the FAIR principles",
"nameUrl": "FHIRandFAIR.html",
"generation": "markdown"
}, {
"title": "FHIR identifiers and FAIR principles",
"nameUrl": "FHIRidentifiers.html",
"generation": "markdown"
}, {
"title": "Non-Invasive Multimodal Foetal ECG-Doppler Dataset for Antenatal Cardiology Research",
"nameUrl": "ninfea.html",
"generation": "markdown"
}, {
"title": "The Medical Information Mart for Intensive Care IV - Emergency Department (MIMIC-IV-ED, v1.0) dataset",
"nameUrl": "mimic.html",
"generation": "markdown"
}, {
"title": "The NFDI4Health consortia",
"nameUrl": "NFDI4Health.html",
"generation": "markdown"
}, {
"title": "The Personal Health Train",
"nameUrl": "PHT.html",
"generation": "markdown"
}, {
"title": "Center for Evidence and Practice Improvement (CEPI) Evidence Discovery and Retrieval (CEDAR) - Making evidence more FAIR",
"nameUrl": "cedar.html",
"generation": "markdown"
}, {
"title": "Useful Downloads",
"nameUrl": "downloads.html",
"generation": "html"
}, {
"title": "Acknowledgments, licenses and copyrights",
"nameUrl": "copyrights.html",
"generation": "markdown"
}, {
"title": "IG Change History",
"nameUrl": "changes.html",
"generation": "html"
} ],
"title": "Table of Contents",
"nameUrl": "toc.html",
"generation": "html"
},
"resource": [ {
"name": "DocumentManifest [Subject Level Medatata]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
} ],
"reference": {
"reference": "StructureDefinition/DocumentManifest-uv-f4f"
},
"description": "This profile defines how to use the DocumentManifest resource to convey metadata information for a FAIR collection of data at the subject level realized by using HL7 FHIR",
"exampleBoolean": false
}, {
"name": "Library [Study Level Medatata]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
} ],
"reference": {
"reference": "StructureDefinition/Library-uv-f4f"
},
"description": "This profile defines how to use the Library resource to convey metadata information for a FAIR dataset realized by using HL7 FHIR",
"exampleBoolean": false
}, {
"name": "List [Subject Level Medatata]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
} ],
"reference": {
"reference": "StructureDefinition/List-uv-f4f"
},
"description": "This profile defines how to use the List resource to convey subject level metadata information for a FAIR collection of data by using HL7 FHIR",
"exampleBoolean": false
}, {
"name": "RelatedArtifact [FHIR for FAIR]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:complex-type"
} ],
"reference": {
"reference": "StructureDefinition/RelatedArtifact-uv-f4f"
},
"description": "This profile enhances the current RelatedArtifact data with the enhancements identified in FHIR R5",
"exampleBoolean": false
}, {
"name": "ResearchStudy [Study Level Medatata]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
} ],
"reference": {
"reference": "StructureDefinition/ResearchStudy-uv-f4f"
},
"description": "This profile defines how to use the ResearchStudy resource to convey metadata information for a FAIR collection of data at the study level realized by using HL7 FHIR",
"exampleBoolean": false
}, {
"name": "Classifier [Resource]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
} ],
"reference": {
"reference": "StructureDefinition/classifier"
},
"description": "This extension allows to assign this resource to an organizing scheme",
"exampleBoolean": false
}, {
"name": "Usage Context [ResearchStudy]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
} ],
"reference": {
"reference": "StructureDefinition/researchStudy-context"
},
"description": "This extension allows ResearchStudy to provide richer information about the context of the study, when not already covered by the already defined elements",
"exampleBoolean": false
}, {
"name": "Copyright",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
} ],
"reference": {
"reference": "StructureDefinition/copyright"
},
"description": "This extension may be used to provide Copyright information about the set of data described by this resource",
"exampleBoolean": false
}, {
"name": "Licence Terms as Attachment",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
} ],
"reference": {
"reference": "StructureDefinition/licenceAttachment"
},
"description": "This extension may be used to provide detailed Licence information about the set of data described by this resource",
"exampleBoolean": false
}, {
"name": "Licence Terms as CodeableConcept",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
} ],
"reference": {
"reference": "StructureDefinition/licenceCodeable"
},
"description": "This extension may be used to provide machine-processable Licence information about the set of data described by this resource",
"exampleBoolean": false
}, {
"name": "Classifier [RelatedArtifact]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
} ],
"reference": {
"reference": "StructureDefinition/relatedArtifactClassifier"
},
"description": "This extension enanches the current RelatedArtifact data type with the classifier element as specified in R5",
"exampleBoolean": false
}, {
"name": "ResourceReference [RelatedArtifact]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
} ],
"reference": {
"reference": "StructureDefinition/relatedArtifactResourceReference"
},
"description": "This extension enanches the current RelatedArtifact data type allowing to reference FHIR resources",
"exampleBoolean": false
}, {
"name": "Type [RelatedArtifact]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
} ],
"reference": {
"reference": "StructureDefinition/relatedArtifactType"
},
"description": "This extension enanches the current RelatedArtifact data type with extending the supported relationship types as specified in R5",
"exampleBoolean": false
}, {
"name": "Content as RelatedArtifact [Library]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
} ],
"reference": {
"reference": "StructureDefinition/library-relatedContent"
},
"description": "This extension allows Library to provide information about content as RelatedArtifact. In the current FHIR version content is an Attachment.",
"exampleBoolean": false
}, {
"name": "Other Subjects [Resource]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:extension"
} ],
"reference": {
"reference": "StructureDefinition/subjectOther"
},
"description": "This extension allows to record kinds of subjects that are not currently supported by some resources (e.g.,DocumentManifest limited to Patient, Practitioner, Group, Device for )",
"exampleBoolean": false
}, {
"name": "RelatedArtifactType [ValueSet]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
} ],
"reference": {
"reference": "ValueSet/related-artifact-type"
},
"description": "The type of relationship to the related artifact.",
"exampleBoolean": false
}, {
"name": "RelatedArtifactType [CodeSystem]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CodeSystem"
} ],
"reference": {
"reference": "CodeSystem/related-artifact-type"
},
"description": "The type of relationship to the related artifact.",
"exampleBoolean": false
}, {
"name": "Sample used by the Subject Level Collection [Condition]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Condition"
} ],
"reference": {
"reference": "Condition/example-f4f-condition"
},
"description": "Example of Condition resource used by the DocumentManifest example.",
"exampleBoolean": true
}, {
"name": "Subject Level Data Collection [List]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "List"
} ],
"reference": {
"reference": "List/example-f4f-list"
},
"description": "Example of usage of the List resource to describe subject level metadata.",
"exampleCanonical": "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/List-uv-f4f"
}, {
"name": "Subject Level Data Collection [DocumentManifest]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "DocumentManifest"
} ],
"reference": {
"reference": "DocumentManifest/example-f4f-manifest"
},
"description": "Example of usage of the DocumentManifest resource to describe subject level metadata.",
"exampleCanonical": "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/DocumentManifest-uv-f4f"
}, {
"name": "MedicationStatement Sample used by the Subject Level Collection [1]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "MedicationStatement"
} ],
"reference": {
"reference": "MedicationStatement/example-f4f-medicationStatement-1"
},
"description": "Example of MedicationStatement resource used by the DocumentManifest example.",
"exampleBoolean": true
}, {
"name": "MedicationStatement Sample used by the Subject Level Collection [2]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "MedicationStatement"
} ],
"reference": {
"reference": "MedicationStatement/example-f4f-medicationStatement-2"
},
"description": "Example of MedicationStatement resource used by the DocumentManifest example.",
"exampleBoolean": true
}, {
"name": "Sample used by the Subject Level Collection [Patient]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Patient"
} ],
"reference": {
"reference": "Patient/example-f4f-patient"
},
"description": "Example of Patient resource used by the DocumentManifest example.",
"exampleBoolean": true
}, {
"name": "FAIR4Health portal [Library]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Library"
} ],
"reference": {
"reference": "Library/f4h-1"
},
"description": "Example of usage of the Library resource to describe project level metadata. This example is based on the data published by the FAIR4Health project thorugh the https://portal.fair4health.eu/ portal",
"exampleCanonical": "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/Library-uv-f4f"
}, {
"name": "FAIR4Health study case 1 [Library]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Library"
} ],
"reference": {
"reference": "Library/f4h-lib-1"
},
"description": "Example of usage of the Library resource to describe study level metadata. This example is based on the FAIR4Health study case 1 Identification of multimorbidity patterns and polypharmacy correlation on the risk of mortality in elderly, and demonstrate the reproducibility of research",
"exampleCanonical": "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/Library-uv-f4f"
}, {
"name": "FAIR4Health study case 2 [Library]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Library"
} ],
"reference": {
"reference": "Library/f4h-lib-2"
},
"description": "Example of usage of the Library resource to describe study level metadata. This example is based on the FAIR4Health study case 2 Develop and pilot an early prediction service for 30-days readmission risk in COPD (Chronic Obstructive Pulmonary Disease) patient",
"exampleCanonical": "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/Library-uv-f4f"
}, {
"name": "FAIR4Health study case 2 [ResearchStudy]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ResearchStudy"
} ],
"reference": {
"reference": "ResearchStudy/f4h-rs-2"
},
"description": "Example of usage of the ResearchStudy resource to describe study level metadata. This example is based on the FAIR4Health study case 2 Develop and pilot an early prediction service for 30-days readmission risk in COPD (Chronic Obstructive Pulmonary Disease) patient",
"exampleCanonical": "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/ResearchStudy-uv-f4f"
}, {
"name": "Non-invasive foetal electrocardiography example [Library]",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Library"
} ],
"reference": {
"reference": "Library/ninfea-1"
},
"description": "Example of usage of the Library reosurce to describe study level metadata. This example is based on the Non-invasive foetal electrocardiography NInFEA case.",
"exampleCanonical": "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/Library-uv-f4f"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "copyrightyear"
}, {
"url": "value",
"valueString": "2020+"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "releaselabel"
}, {
"url": "value",
"valueString": "STU 1"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-jurisdiction"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-publisher"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-version"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-history"
}, {
"url": "value",
"valueString": "http://hl7.org/fhir/uv/fhir-for-fair/history.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "autoload-resources"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-liquid"
}, {
"url": "value",
"valueString": "template/liquid"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-liquid"
}, {
"url": "value",
"valueString": "input/liquid"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-qa"
}, {
"url": "value",
"valueString": "temp/qa"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-temp"
}, {
"url": "value",
"valueString": "temp/pages"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-output"
}, {
"url": "value",
"valueString": "output"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "path-suppressed-warnings"
}, {
"url": "value",
"valueString": "input/ignoreWarnings.txt"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "template-html"
}, {
"url": "value",
"valueString": "template-page.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "template-md"
}, {
"url": "value",
"valueString": "template-page-md.html"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-contact"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-context"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-copyright"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "apply-license"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "active-tables"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "fmm-definition"
}, {
"url": "value",
"valueString": "http://hl7.org/fhir/versions.html#maturity"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "propagate-status"
}, {
"url": "value",
"valueString": "true"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
"extension": [ {
"url": "code",
"valueString": "excludelogbinaryformat"
}, {
"url": "value",
"valueString": "true"
} ]
} ],
"parameter": [ {
"code": "path-resource",
"value": "input/capabilities"
}, {
"code": "path-resource",
"value": "input/examples"
}, {
"code": "path-resource",
"value": "input/extensions"
}, {
"code": "path-resource",
"value": "input/models"
}, {
"code": "path-resource",
"value": "input/operations"
}, {
"code": "path-resource",
"value": "input/profiles"
}, {
"code": "path-resource",
"value": "input/resources"
}, {
"code": "path-resource",
"value": "input/vocabulary"
}, {
"code": "path-resource",
"value": "input/maps"
}, {
"code": "path-resource",
"value": "input/testing"
}, {
"code": "path-resource",
"value": "input/history"
}, {
"code": "path-resource",
"value": "fsh-generated/resources"
}, {
"code": "path-pages",
"value": "template/config"
}, {
"code": "path-pages",
"value": "input/images"
}, {
"code": "path-tx-cache",
"value": "input-cache/txcache"
} ]
},
"date": "2022-09-28T16:10:33+00:00",
"publisher": "Health Level Seven International - SOA Work Group",
"fhirVersion": [ "4.3.0" ],
"license": "CC0-1.0",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"dependsOn": [ {
"id": "higtools",
"uri": "http://hl7.org/fhir/tools/ImplementationGuide/hl7.fhir.uv.tools",
"version": "current",
"packageId": "hl7.fhir.uv.tools"
}, {
"id": "hl7tx",
"uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
"version": "4.0.0",
"packageId": "hl7.terminology.r4"
} ],
"name": "FhirForFairIG",
"type": null,
"experimental": null,
"resourceType": "ImplementationGuide",
"title": "FHIR for FAIR - FHIR Implementation Guide",
"package_version": "1.0.0",
"status": "active",
"id": "3e5e88e2-934d-4a19-a5e5-847f1aa0eee5",
"kind": null,
"url": "http://hl7.org/fhir/uv/fhir-for-fair/ImplementationGuide/hl7.fhir.uv.fhir-for-fair",
"version": "1.0.0",
"packageId": "hl7.fhir.uv.fhir-for-fair",
"contact": [ {
"name": "Health Level Seven International - SOA Work Group",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/soa",
"system": "url"
} ]
}, {
"name": "HL7 SOA Work Group",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/soa",
"system": "url"
} ]
} ]
}