Research Data Sharing IG
1.0.0 - CI Build International flag

Research Data Sharing IG, published by IEHR-Workgroup. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/InteropEHRate-project/research-data-sharing/ and changes regularly. See the Directory of published versions

: ResearchStudy Example - 1 - JSON Representation

Raw json | Download


{
  "resourceType" : "Bundle",
  "id" : "877311",
  "language" : "en",
  "type" : "collection",
  "timestamp" : "2022-05-10T10:17:40.803+02:00",
  "entry" : [
    {
      "fullUrl" : "http://interopEHRate.eu/fhir-resource/ResearchStudy/exampleResearchStudy",
      "resource" : {
        "resourceType" : "ResearchStudy",
        "id" : "exampleResearchStudy",
        "meta" : {
          "profile" : [
            🔗 "http://interopehrate.eu/fhir/StructureDefinition/ResearchStudy-IEHR"
          ]
        },
        "language" : "en",
        "text" : {
          "status" : "extensions",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">To Prevent Error</div>"
        },
        "extension" : [
          {
            "url" : "http://interopehrate.eu/fhir/StructureDefinition/EnrollmentPeriodExtension-IEHR",
            "valuePeriod" : {
              "start" : "2020-01-01",
              "end" : "2020-07-01"
            }
          },
          {
            "url" : "http://interopehrate.eu/fhir/StructureDefinition/AnonymizationExtension-IEHR",
            "valueCoding" : {
              "system" : "http://interopehrate.eu/fhir/CodeSystem/AnonymizationType-IEHR",
              "code" : "anonymization",
              "display" : "Anonymization"
            }
          },
          {
            "extension" : [
              {
                "url" : "DataRequirement",
                "valueDataRequirement" : {
                  "extension" : [
                    {
                      "url" : "http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR",
                      "valueTiming" : {
                        "repeat" : {
                          "frequency" : 2,
                          "period" : 1,
                          "periodUnit" : "mo"
                        }
                      }
                    }
                  ],
                  "type" : "Observation",
                  "codeFilter" : [
                    {
                      "path" : "category",
                      "code" : [
                        {
                          "system" : "http://loinc.org",
                          "code" : "8716-3",
                          "display" : "Vital Signs"
                        }
                      ]
                    }
                  ],
                  "dateFilter" : [
                    {
                      "path" : "effectivePeriod",
                      "valuePeriod" : {
                        "start" : "2015-09-14",
                        "end" : "2025-09-14"
                      }
                    }
                  ]
                }
              },
              {
                "url" : "DataRequirement",
                "valueDataRequirement" : {
                  "extension" : [
                    {
                      "url" : "http://interopehrate.eu/fhir/StructureDefinition/FrequencyExtension-IEHR",
                      "valueTiming" : {
                        "repeat" : {
                          "frequency" : 2,
                          "period" : 1,
                          "periodUnit" : "mo"
                        }
                      }
                    }
                  ],
                  "type" : "Observation",
                  "codeFilter" : [
                    {
                      "path" : "code",
                      "code" : [
                        {
                          "system" : "http://loinc.org",
                          "code" : "29463-7",
                          "display" : "Body weight"
                        }
                      ]
                    }
                  ],
                  "dateFilter" : [
                    {
                      "path" : "effectivePeriod",
                      "valuePeriod" : {
                        "start" : "2015-09-14",
                        "end" : "2025-09-14"
                      }
                    }
                  ]
                }
              },
              {
                "url" : "DataRequirement",
                "valueDataRequirement" : {
                  "type" : "Medication",
                  "codeFilter" : [
                    {
                      "path" : "medicationCodeableConcept",
                      "code" : [
                        {
                          "system" : "http://snomed.info/sct",
                          "code" : "3142009",
                          "display" : "Azacyclonol"
                        }
                      ]
                    }
                  ],
                  "dateFilter" : [
                    {
                      "path" : "effectivePeriod",
                      "valuePeriod" : {
                        "start" : "2020-09-14",
                        "end" : "2025-09-14"
                      }
                    }
                  ]
                }
              }
            ],
            "url" : "http://interopehrate.eu/fhir/StructureDefinition/DataSetDefinitionExtension-IEHR"
          }
        ],
        "identifier" : [
          {
            "system" : "urn:oid:1.11.111.1.1.11.111.11",
            "value" : "ResearchStudy/exampleResearchStudy"
          }
        ],
        "title" : "ResearchStudyIHR Example",
        "status" : "active",
        "primaryPurposeType" : {
          "coding" : [
            {
              "system" : "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type",
              "code" : "diagnostic",
              "display" : "Diagnostic"
            }
          ]
        },
        "contact" : [
          {
            "name" : "Mr Alberto Milano",
            "telecom" : [
              {
                "system" : "phone",
                "value" : "11111111"
              }
            ]
          }
        ],
        "location" : [
          {
            "coding" : [
              {
                "system" : "urn:iso:std:iso:3166",
                "code" : "IT",
                "display" : "Italy"
              }
            ]
          }
        ],
        "description" : "This is an exampleResearchStudy that is used to show the realisation of the constraints in a FHIR-Resource: \n-pseudo-anonymization is in the ResearchStudys Anonymization Extension\n-constraints on the patients diagnosis is in Group.characteristic. The second characteristic specifies, that only patients with a heart failure between  2019-05-04 and 2020-05-04 can be chosen. If the exclude attribute would be flipped to true it would exclude patients with this diagnosis\n-constraints on patient's drug therapy is in Group.characteristic. The third characteristic specifies, that only patients that took Methanthelinium in the period from  2019-05-04 and 2020-05-04\n-drug treatment plan within data set definition is in the third DataRequirement. It requests MedicationStatements from 2020-09-14 until 2025-09-14 where Azacyclonol was prescribed\n-specification of period within dataset definition is shown in all DataRequirement with the dateFilter\n-evaluation data (blood tests, vital signs, visits, instrumental examination) within data set definition is shown in the first and second DataRequirement. If the type is set to Observation the path can be set to category to request a category of Observations ( all vital signs in the first) or to code if a specific observation is required (only body weight in the second)\n-constraints on min and max value of patient's attributes within enrollment criteria are shown in the second Group.characteristic, that specifies that only people between the ages of 30 and 60 can take part\n-name within publishable research protocol, the name of the study can be displayed in the ResearchStudy.title Attribute. Additional information about the study can be added in the ResearchStudy.description\n-machine interpretable research protocol for publication",
        "enrollment" : [
          {
            🔗 "reference" : "Group/1"
          }
        ],
        "period" : {
          "start" : "2020-07-09",
          "end" : "2025-09-14"
        },
        "site" : [
          {
            🔗 "reference" : "Location/1"
          }
        ]
      }
    },
    {
      "fullUrl" : "http://interopEHRate.eu/fhir-resource/Group/1",
      "resource" : {
        "resourceType" : "Group",
        "id" : "1",
        "meta" : {
          "profile" : [
            🔗 "http://interopehrate.eu/fhir/StructureDefinition/Group-Cohort-IEHR"
          ]
        },
        "text" : {
          "status" : "generated",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Group_1\"> </a><p><b>Generated Narrative: Group</b><a name=\"1\"> </a><a name=\"hc1\"> </a></p><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\">Resource Group &quot;1&quot; </p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-Group-Cohort-IEHR.html\">Cohort</a></p></div><p><b>type</b>: person</p><p><b>actual</b>: false</p><blockquote><p><b>characteristic</b></p><p><b>code</b>: Sex [HL7.v3] <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://loinc.org/\">LOINC</a>#72143-1)</span></p><p><b>value</b>: Male <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://hl7.org/fhir/R4/codesystem-administrative-gender.html\">AdministrativeGender</a>#male)</span></p><p><b>exclude</b>: false</p></blockquote><blockquote><p><b>characteristic</b></p><p><b>code</b>: Age <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://loinc.org/\">LOINC</a>#30525-0)</span></p><p><b>value</b>: 30-60</p><p><b>exclude</b>: false</p></blockquote><blockquote><p><b>characteristic</b></p><p><b>code</b>: Observation <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"CodeSystem-GroupCharacteristic-Code.html\">Possible codes for GroupCharacteristic</a>#observation)</span></p><p><b>value</b>: Heart failure <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.3.0/CodeSystem-icd10CM.html\">International Classification of Diseases, 10th Revision, Clinical Modification (ICD-10-CM)</a>#I50)</span></p><p><b>exclude</b>: false</p><p><b>period</b>: 2019-05-04 --&gt; 2020-05-04</p></blockquote><blockquote><p><b>characteristic</b></p><p><b>code</b>: Medications <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://loinc.org/\">LOINC</a>#52471-0)</span></p><p><b>value</b>: Methanthelinium <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#2796008)</span></p><p><b>exclude</b>: false</p></blockquote></div>"
        },
        "type" : "person",
        "actual" : false,
        "characteristic" : [
          {
            "code" : {
              "coding" : [
                {
                  "system" : "http://loinc.org",
                  "code" : "72143-1",
                  "display" : "Sex [HL7.v3]"
                }
              ]
            },
            "valueCodeableConcept" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/administrative-gender",
                  "code" : "male",
                  "display" : "Male"
                }
              ]
            },
            "exclude" : false
          },
          {
            "code" : {
              "coding" : [
                {
                  "system" : "http://loinc.org",
                  "code" : "30525-0",
                  "display" : "Age"
                }
              ]
            },
            "valueRange" : {
              "low" : {
                "value" : 30
              },
              "high" : {
                "value" : 60
              }
            },
            "exclude" : false
          },
          {
            "code" : {
              "coding" : [
                {
                  "system" : "http://interopehrate.eu/fhir/CodeSystem/GroupCharacteristic-Code",
                  "code" : "observation",
                  "display" : "Observation"
                }
              ]
            },
            "valueCodeableConcept" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/sid/icd-10-cm",
                  "code" : "I50",
                  "display" : "Heart failure"
                }
              ]
            },
            "exclude" : false,
            "period" : {
              "start" : "2019-05-04",
              "end" : "2020-05-04"
            }
          },
          {
            "code" : {
              "coding" : [
                {
                  "system" : "http://loinc.org",
                  "code" : "52471-0",
                  "display" : "Medications"
                }
              ]
            },
            "valueCodeableConcept" : {
              "coding" : [
                {
                  "system" : "http://snomed.info/sct",
                  "code" : "2796008",
                  "display" : "Methanthelinium"
                }
              ]
            },
            "exclude" : false
          }
        ]
      }
    },
    {
      "fullUrl" : "http://interopEHRate.eu/fhir-resource/Location/1",
      "resource" : {
        "resourceType" : "Location",
        "id" : "1",
        "meta" : {
          "profile" : [
            🔗 "http://interopehrate.eu/fhir/StructureDefinition/Location-ReferenceResearchCenter-IEHR"
          ]
        },
        "text" : {
          "status" : "generated",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Location_1\"> </a><p><b>Generated Narrative: Location</b><a name=\"1\"> </a><a name=\"hc1\"> </a></p><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\">Resource Location &quot;1&quot; </p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-Location-ReferenceResearchCenter-IEHR.html\">ResearchLocation</a></p></div><p><b>identifier</b>: <code>urn:oid:1.11.111.1.1.11.111.11</code>/exampleLocation</p><p><b>name</b>: Cardiovascular practice Milano</p><p><b>type</b>: Cardiovascular diagnostics or therapeutics unit <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.3.0/CodeSystem-v3-RoleCode.html\">RoleCode</a>#CVDX)</span></p><p><b>telecom</b>: ph: 11111111</p><p><b>address</b>: Viale Certosa, 27111111 Milano 20019 Italy </p><p><b>endpoint</b>: See on this page: Endpoint/exampleEndpoint</p></div>"
        },
        "identifier" : [
          {
            "system" : "urn:oid:1.11.111.1.1.11.111.11",
            "value" : "exampleLocation"
          }
        ],
        "name" : "Cardiovascular practice Milano",
        "type" : [
          {
            "coding" : [
              {
                "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code" : "CVDX",
                "display" : "Cardiovascular diagnostics or therapeutics unit"
              }
            ]
          }
        ],
        "telecom" : [
          {
            "system" : "phone",
            "value" : "11111111"
          }
        ],
        "address" : {
          "type" : "postal",
          "line" : [
            "Viale Certosa, 27111111"
          ],
          "city" : "Milano",
          "postalCode" : "20019",
          "country" : "Italy"
        },
        "endpoint" : [
          {
            "reference" : "Endpoint/exampleEndpoint"
          }
        ]
      }
    },
    {
      "fullUrl" : "http://interopEHRate.eu/fhir-resource/Endpoint/exampleEndpoint",
      "resource" : {
        "resourceType" : "Endpoint",
        "id" : "exampleEndpoint",
        "text" : {
          "status" : "generated",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Endpoint_exampleEndpoint\"> </a><p><b>Generated Narrative: Endpoint</b><a name=\"exampleEndpoint\"> </a><a name=\"hcexampleEndpoint\"> </a></p><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\">Resource Endpoint &quot;exampleEndpoint&quot; </p></div><p><b>status</b>: off</p><p><b>connectionType</b>: HL7 FHIR (Details: http://terminology.hl7.org/CodeSystem/endpoint-connection-type code hl7-fhir-rest = 'HL7 FHIR', stated as 'HL7 FHIR')</p><p><b>payloadType</b>: Any <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.3.0/CodeSystem-endpoint-payload-type.html\">Endpoint Payload Type</a>#any)</span></p><p><b>address</b>: <a href=\"http://interopEHRate.eu/fhir-resource/\">http://interopEHRate.eu/fhir-resource/</a></p></div>"
        },
        "status" : "off",
        "connectionType" : {
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code" : "hl7-fhir-rest",
          "display" : "HL7 FHIR"
        },
        "payloadType" : [
          {
            "coding" : [
              {
                "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
                "code" : "any",
                "display" : "Any"
              }
            ]
          }
        ],
        "address" : "http://interopEHRate.eu/fhir-resource/"
      }
    }
  ]
}