MII-Initiative

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

Dokument (DocumentReference)


Beschreibung

Dieses Profil beschreibt ein Dokument / Publikation in der Medizininformatik-Initiative.

NameCanonical
MII_PR_Studie_Dokumenthttps://www.medizininformatik-initiative.de/fhir/modul-studie/StructureDefinition/mii-pr-studie-dokument

Differential

masterIdentifierΣ0..1Identifier
identifierΣ0..*Identifier
statusS Σ ?!1..1codeBinding
docStatusΣ0..1codeBinding
typeΣ0..1CodeableConceptBinding
categoryΣ0..*CodeableConcept
subjectΣ I0..1Reference(Patient | Practitioner | Group | Device)
dateΣ0..1instant
authorS Σ I0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)
authenticatorI0..1Reference(Practitioner | PractitionerRole | Organization)
custodianS I0..1Reference(Organization)
codeΣ1..1codeBinding
targetΣ I1..1Reference(DocumentReference)
descriptionΣ0..1string
securityLabelΣ0..*CodeableConceptBinding
contentTypeS Σ1..1codeBinding
languageΣ0..1codeBinding
data0..1base64Binary
urlS Σ1..1url
sizeS Σ0..1unsignedInt
hashΣ0..1base64Binary
titleS Σ0..1string
creationΣ0..1dateTime
formatΣ0..1CodingBinding
encounterI0..*Reference(Encounter | EpisodeOfCare)
event0..*CodeableConcept
periodΣ I0..1Period
facilityType0..1CodeableConcept
practiceSetting0..1CodeableConcept
sourcePatientInfoI0..1Reference(Patient)
relatedS I0..*Reference(Resource)


Hinweise

FHIR-Element Erklärung
DocumentReference.id Must-support, jedoch optional
DocumentReference.meta Must-support, jedoch optional
DocumentReference.meta.profile Verpflichtend für die Abfrage im DIZ-Repository inkl. Versionsnummer des Profils. Siehe CapabilityStatement. In allen anderen Fällen optional.
DocumentReference.content.attachment.url Diese absolute URL sollte auf einen Binary-Endpunkt eines FHIR-Servers verweisen. Die Hinweise der FHIR-Kernspezifikation zum Abruf von Binary-Ressourcen sind zu beachten.
DocumentReference.content.attachment.title Der Titel sollte eine sinnvolle menschenlesbare Beschreibung enthalten, das Element sollte nicht für den Dateinamen verwendet werden.
DocumentReference.custodian Sollte der Standort nicht als Organization-Ressource verfügbar sein, kann auch ggf. Reference.display oder Referenz.identifier verwendet werden.
DocumentReference.author Sollte der Author nicht als Practitioner-Ressource verfügbar sein, kann auch ggf. Reference.display oder Referenz.identifier verwendet werden.
DocumentReference.context.related Angabe des Studienkontexts

Mapping

FHIR Element Logischer Datensatz
DocumentReference.content.attachment.url Forschungsvorhaben.Publikation.url
DocumentReference.content.attachment.title Forschungsvorhaben.Publikation.Titel
DocumentReference.author Forschungsvorhaben.Publikation.Autor
FHIR Element Logischer Datensatz
DocumentReference.content.attachment.title Forschungsvorhaben.Datennutzungsantrag.Dokument.Name
DocumentReference.author Forschungsvorhaben.Datennutzungsantrag.Dokument.Autor
DocumentReference.content.attachment.contentType Forschungsvorhaben.Datennutzungsantrag.Dokument.Dateityp
DocumentReference.custodian Forschungsvorhaben.Datennutzungsantrag.Dokument.Standort
DocumentReference.content.attachment.size Forschungsvorhaben.Datennutzungsantrag.Dokument.Dateigroesse
DocumentReference.content.attachment.url Forschungsvorhaben.Datennutzungsantrag.Dokument.url

Snapshot

masterIdentifierΣ0..1Identifier
identifierΣ0..*Identifier
statusS Σ ?!1..1codeBinding
docStatusΣ0..1codeBinding
typeΣ0..1CodeableConceptBinding
categoryΣ0..*CodeableConcept
subjectΣ I0..1Reference(Patient | Practitioner | Group | Device)
dateΣ0..1instant
authorS Σ I0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)
authenticatorI0..1Reference(Practitioner | PractitionerRole | Organization)
custodianS I0..1Reference(Organization)
codeΣ1..1codeBinding
targetΣ I1..1Reference(DocumentReference)
descriptionΣ0..1string
securityLabelΣ0..*CodeableConceptBinding
contentTypeS Σ1..1codeBinding
languageΣ0..1codeBinding
data0..1base64Binary
urlS Σ1..1url
sizeS Σ0..1unsignedInt
hashΣ0..1base64Binary
titleS Σ0..1string
creationΣ0..1dateTime
formatΣ0..1CodingBinding
encounterI0..*Reference(Encounter | EpisodeOfCare)
event0..*CodeableConcept
periodΣ I0..1Period
facilityType0..1CodeableConcept
practiceSetting0..1CodeableConcept
sourcePatientInfoI0..1Reference(Patient)
relatedS I0..*Reference(Resource)


Suchparameter

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

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

    Beispiele:

    GET [base]/DocumentReference?_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]/DocumentReference?_profile=https://www.medizininformatik-initiative.de/fhir/modul-studie/StructureDefinition/mii-pr-studie-dokument

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

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

    Beispiele

    GET [base]/DocumentReference?author=Practitioner/practitioner-test

    Anwendungshinweise: Weitere Informationen zur Suche nach "DocumentReference.author" finden sich in der FHIR-Basisspezifikation - Abschnitt "reference".

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

    Beispiele

    GET [base]/DocumentReference?custodian=Organization/organization-test

    Anwendungshinweise: Weitere Informationen zur Suche nach "DocumentReference.custodian" finden sich in der FHIR-Basisspezifikation - Abschnitt "reference".

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

    Beispiele

    GET [base]/DocumentReference?status=current

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

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

    Beispiele

    GET [base]/DocumentReference?location=https://example.com/fhir/Binary/document

    Anwendungshinweise: Weitere Informationen zur Suche nach "DocumentReference.content.attachment.url" finden sich in der FHIR-Basisspezifikation - Abschnitt "uri".

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

    Beispiele

    GET [base]/DocumentReference?contenttype=application/pdf

    Anwendungshinweise: Weitere Informationen zur Suche nach "DocumentReference.content.attachment.contentType" finden sich in der FHIR-Basisspezifikation - Abschnitt "token".

  8. Der Suchparameter "title" MUSS unterstützt werden:

    Beispiele:

    GET [base]/DocumentReference?title=Beispiel Dokument

    Anwendungshinweise: Weitere Informationen zur Suche nach "DocumentReference.content.attachment.title" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".

  9. Der Suchparameter "size" MUSS unterstützt werden:

    Beispiele:

    GET [base]/DocumentReference?size=1000

    Anwendungshinweise: Weitere Informationen zur Suche nach "DocumentReference.content.attachment.size" finden sich in der FHIR-Basisspezifikation - Abschnitt "Number Search".

  10. Der Suchparameter "related" MUSS unterstützt werden:

    Beispiele:

    GET [base]/DocumentReference?related=ResearchStudy/example

    Anwendungshinweise: Weitere Informationen zur Suche nach "DocumentReference.context.related" finden sich in der FHIR-Basisspezifikation - Abschnitt "reference".


Beispiele

Beispiel (minimal):

{
    "resourceType": "DocumentReference",
    "id": "mii-exa-studie-dokument",
    "meta": {
        "profile":  [
            "https://www.medizininformatik-initiative.de/fhir/modul-studie/StructureDefinition/mii-pr-studie-dokument"
        ]
    },
    "status": "current",
    "content":  [
        {
            "attachment": {
                "url": "https://example.com/fhir/Binary/document",
                "title": "Beispiel Dokument",
                "contentType": "application/pdf",
                "size": 2000
            }
        }
    ],
    "author":  [
        {
            "reference": "Organization/Example"
        }
    ],
    "custodian": {
        "reference": "Organization/Example"
    },
    "context": {
        "related":  [
            {
                "reference": "ResearchStudy/Example"
            }
        ]
    }
}