MII-Initiative

[DE] Medizininformatik Initiative - Medizinische Forschungsvorhaben - Implementierungsleitfaden - Version 1.0

Register (Library)


Beschreibung

Dieses Profil beschreibt ein Forschungsregister in der Medizininformatik-Initiative.

NameCanonical
MII_PR_Studie_Registerhttps://www.medizininformatik-initiative.de/fhir/modul-studie/StructureDefinition/mii-pr-studie-register

Differential

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
urlΣ0..1uri
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
versionΣ0..1string
nameS Σ I0..1string
titleΣ0..1string
subtitle0..1string
statusΣ ?!1..1codeBinding
experimentalΣ0..1boolean
typeS Σ1..1CodeableConceptBindingPattern
subjectCodeableConceptCodeableConcept
subjectReferenceReference(Group)
dateΣ0..1dateTime
publisherΣ0..1string
contactΣ0..*ContactDetail
descriptionΣ0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
purpose0..1markdown
usage0..1string
copyright0..1markdown
approvalDate0..1date
lastReviewDate0..1date
effectivePeriodΣ I0..1Period
topic0..*CodeableConcept
author0..*ContactDetail
editor0..*ContactDetail
reviewer0..*ContactDetail
endorser0..*ContactDetail
id0..1string
extensionI0..*Extension
typeΣ1..1codeBinding
labelΣ0..1string
displayΣ0..1string
citationΣ0..1markdown
urlΣ0..1url
id0..1string
extensionI0..*Extension
contentTypeΣ0..1codeBinding
languageΣ0..1codeBinding
data0..1base64Binary
urlS Σ1..1url
sizeΣ0..1unsignedInt
hashΣ0..1base64Binary
titleΣ0..1string
creationΣ0..1dateTime
resourceΣ0..1canonical(Resource)
parameter0..*ParameterDefinition
dataRequirement0..*DataRequirement
contentΣ I0..*Attachment


Hinweise

FHIR-Element Erklärung
Library.id Must-support, jedoch optional
Library.meta Must-support, jedoch optional
Library.meta.profile Verpflichtend für die Abfrage im DIZ-Repository inkl. Versionsnummer des Profils. Siehe CapabilityStatement. In allen anderen Fällen optional.
Library.name Es sollte ein geeigneter menschenlesbarer Name verwendet werden
Library.identifier In den meisten Fällen existiert bisher kein NamingSystem für die Vergabe der RegisterIds. Ein eigenes lokales NamingSystem sollte daher verwendet werden.
Library.relatedArtifact.document.url Homepage des Registers bzw. Link zur weiterführenden Dokumentation

Mapping

FHIR Element Logischer Datensatz
Library.name Forschungsvorhaben.Studienregister.Registername
Library.identifier Forschungsvorhaben.Studienregister.RegisterId
Library.relatedArtifact.document.url Forschungsvorhaben.Studienregister.url

Snapshot

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
urlΣ0..1uri
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
versionΣ0..1string
nameS Σ I0..1string
titleΣ0..1string
subtitle0..1string
statusΣ ?!1..1codeBinding
experimentalΣ0..1boolean
typeS Σ1..1CodeableConceptBindingPattern
subjectCodeableConceptCodeableConcept
subjectReferenceReference(Group)
dateΣ0..1dateTime
publisherΣ0..1string
contactΣ0..*ContactDetail
descriptionΣ0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
purpose0..1markdown
usage0..1string
copyright0..1markdown
approvalDate0..1date
lastReviewDate0..1date
effectivePeriodΣ I0..1Period
topic0..*CodeableConcept
author0..*ContactDetail
editor0..*ContactDetail
reviewer0..*ContactDetail
endorser0..*ContactDetail
id0..1string
extensionI0..*Extension
typeΣ1..1codeBinding
labelΣ0..1string
displayΣ0..1string
citationΣ0..1markdown
urlΣ0..1url
id0..1string
extensionI0..*Extension
contentTypeΣ0..1codeBinding
languageΣ0..1codeBinding
data0..1base64Binary
urlS Σ1..1url
sizeΣ0..1unsignedInt
hashΣ0..1base64Binary
titleΣ0..1string
creationΣ0..1dateTime
resourceΣ0..1canonical(Resource)
parameter0..*ParameterDefinition
dataRequirement0..*DataRequirement
contentΣ I0..*Attachment


Suchparameter

Folgende Suchparameter sind für das Modul Studie relevant, auch in Kombination:

  1. Der Suchparameter "_id" MUSS unterstützt werden:

    Beispiele:

    GET [base]/Library?_id=103270

    Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".

  2. Der Suchparameter "_profile" MUSS unterstützt werden:

    Beispiele:

    GET [base]/Library?_profile=https://www.medizininformatik-initiative.de/fhir/modul-studie/StructureDefinition/mii-pr-studie-register

    Anwendungshinweise: Weitere Informationen zur Suche nach "_profile" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".

  3. Der Suchparameter "name" MUSS unterstützt werden:

    Beispiele:

    GET [base]/Library?name=DRKS - Deutsches Register Klinischer Studien

    Anwendungshinweise: Weitere Informationen zur Suche nach "Library.name" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".

  4. Der Suchparameter "identifier" MUSS unterstützt werden:

    Beispiele

    GET [base]/Library?identifier=DRKS

    Anwendungshinweise: Weitere Informationen zur Suche nach "Library.identifier" finden sich in der FHIR-Basisspezifikation - Abschnitt "token".

  5. Der Suchparameter "quellregister" MUSS unterstützt werden:

    Beispiele

    GET [base]/Library?quellregister=true

    Anwendungshinweise: Weitere Informationen zur Suche nach "Library.extension:QuellRegister" finden sich in der FHIR-Basisspezifikation - Abschnitt "token".

  6. Der Suchparameter "type" MUSS unterstützt werden:

    Beispiele

    GET [base]/Library?type=http://terminology.hl7.org/CodeSystem/library-type|asset-collection

    Anwendungshinweise: Weitere Informationen zur Suche nach "Library.type" finden sich in der FHIR-Basisspezifikation - Abschnitt "token".

  7. Der Suchparameter "relatedArtifactUrl" MUSS unterstützt werden:

    Beispiele

    GET [base]/Library?relatedArtifactUrl=https://drks.de/

    Anwendungshinweise: Weitere Informationen zur Suche nach "Library.relatedArtifact.document.url" finden sich in der FHIR-Basisspezifikation - Abschnitt "uri".


Beispiele

Beispiel (minimal):

{
    "resourceType": "Library",
    "id": "mii-exa-studie-register",
    "meta": {
        "profile":  [
            "https://www.medizininformatik-initiative.de/fhir/modul-studie/StructureDefinition/mii-pr-studie-register"
        ]
    },
    "type": {
        "coding":  [
            {
                "code": "asset-collection",
                "system": "http://terminology.hl7.org/CodeSystem/library-type"
            }
        ]
    },
    "status": "active",
    "name": "DRKS - Deutsches Register Klinischer Studien",
    "identifier":  [
        {
            "value": "DRKS",
            "system": "https://example.com/fhir/sid/drks"
        }
    ],
    "relatedArtifact":  [
        {
            "document": {
                "url": "https://drks.de/"
            },
            "type": "documentation"
        }
    ]
}