This page is part of the MII IG Dokument (v2027.0.0-ballot.2: 2027 Ballot 3) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Search Parameters

This page gives example calls for the search parameters of the Dokument module. The supported search parameters are defined normatively in the module's CapabilityStatement; the standard search parameters are defined by the FHIR base specification (DocumentReference). The Dokument module defines no SearchParameter artifacts of its own — the three module-specific search parameters are provided by the Meta module (package kerndatensatz.meta 2027.0.0-ballot.rc3):

• doc-status — SearchParameter mii-sp-meta-dokument-documentreference-doc-status (https://www.medizininformatik-initiative.de/fhir/modul-meta/SearchParameter/mii-sp-meta-dokument-documentreference-doc-status)
• creation — SearchParameter mii-sp-meta-dokument-documentreference-attachment-creation (https://www.medizininformatik-initiative.de/fhir/modul-meta/SearchParameter/mii-sp-meta-dokument-documentreference-attachment-creation)
• nlp-processing-status — SearchParameter mii-sp-meta-dokument-documentreference-nlp-processing-status (https://www.medizininformatik-initiative.de/fhir/modul-meta/SearchParameter/mii-sp-meta-dokument-documentreference-nlp-processing-status)

Example calls

Example calls for the search parameters the CapabilityStatement requires (they can be combined):

1. _id

   Examples:

   GET [base]/DocumentReference?_id=12345

   Usage notes: further information on searching by "_id" can be found in the FHIR base specification - section "Token Search".

2. _profile

   Examples:

   GET [base]/DocumentReference?_profile=https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/StructureDefinition/mii-pr-dokument-dokument

   Usage notes: further information on searching by "_profile" can be found in the FHIR base specification - section "URI Search".

3. identifier

   Examples:

   GET [base]/DocumentReference?identifier=urn:ietf:rfc:3986|urn:uuid:0c287d32-01e3-4d87-9953-9fcc9404eb21

   Usage notes: further information on searching by "identifier" can be found in the FHIR base specification - section "Token Search".

4. status

   Examples:

   GET [base]/DocumentReference?status=current

   Usage notes: further information on searching by "status" can be found in the FHIR base specification - section "Token Search".

5. doc-status

   Examples:

   GET [base]/DocumentReference?doc-status=final

   Usage notes: further information on searching by "doc-status" can be found in the FHIR base specification - section "Token Search".

6. type

   Examples:

   GET [base]/DocumentReference?type=http://dvmd.de/fhir/CodeSystem/kdl|AD010110

   Usage notes: further information on searching by "type" can be found in the FHIR base specification - section "Token Search".

7. category

   Examples:

   GET [base]/DocumentReference?category=http://ihe-d.de/CodeSystems/IHEXDSclassCode|BRI

   Usage notes: further information on searching by "category" can be found in the FHIR base specification - section "Token Search".

8. patient

   Examples:

   GET [base]/DocumentReference?patient=Patient/AmandaAlzheimer

   Usage notes: further information on searching by "patient" can be found in the FHIR base specification - section "Reference Search".

9. relation

   Examples:

   GET [base]/DocumentReference?relation=http://hl7.org/fhir/document-relationship-type|transforms

   Usage notes: further information on searching by "relation" can be found in the FHIR base specification - section "Token Search".

10. relatesto

    Examples:

    GET [base]/DocumentReference?relatesto=DocumentReference/AmandaAlzheimerOriginalDokument

    Usage notes: further information on searching by "relatesto" can be found in the FHIR base specification - section "Reference Search".

11. relationship

    Examples:

    GET [base]/DocumentReference?relationship=http://hl7.org/fhir/document-relationship-type|transforms$DocumentReference/AmandaAlzheimerOriginalDokument

    Usage notes: further information on searching by "relationship" can be found in the FHIR base specification - section "Composite Search".

12. description

    Examples:

    GET [base]/DocumentReference?description:contains=Bericht

    Usage notes: further information on searching by "description" can be found in the FHIR base specification - section "String Search".

13. security-label

    Examples:

    GET [base]/DocumentReference?security-label=http://terminology.hl7.org/CodeSystem/v3-Confidentiality|L

    Usage notes: further information on searching by "security-label" can be found in the FHIR base specification - section "Token Search".

14. contenttype

    Examples:

    GET [base]/DocumentReference?contenttype=urn:ietf:bcp:13|text/plain

    Usage notes: further information on searching by "contenttype" can be found in the FHIR base specification - section "Token Search".

15. language

    Examples:

    GET [base]/DocumentReference?language=urn:ietf:bcp:47|de-AT

    Usage notes: further information on searching by "language" can be found in the FHIR base specification - section "Token Search".

16. location

    Examples:

    GET [base]/DocumentReference?location=below:http://uk-musterstadt.de/document-management-system

    Usage notes: further information on searching by "location" can be found in the FHIR base specification - section "URI Search".

17. creation

    Examples:

    GET [base]/DocumentReference?creation=eq2025-06-23

    Usage notes: further information on searching by "creation" can be found in the FHIR base specification - section "Date Search".

18. format

    Examples:

    GET [base]/DocumentReference?format=http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode|urn:ihe:iti:xds:2017:mimeTypeSufficient

    Usage notes: further information on searching by "format" can be found in the FHIR base specification - section "Token Search".

19. encounter

    Examples:

    GET [base]/DocumentReference?encounter=Encounter/AmandaAlzheimerEinrichtungskontakt

    Usage notes: further information on searching by "encounter" can be found in the FHIR base specification - section "Reference Search".

20. event

    Examples:

    GET [base]/DocumentReference?event=http://ihe-d.de/CodeSystems/FallkontextBeiDokumentenerstellung|E234

    Usage notes: further information on searching by "event" can be found in the FHIR base specification - section "Token Search".

21. period

    Examples:

    GET [base]/DocumentReference?period=ge2028-01-24&period=le2028-02-06

    Usage notes: further information on searching by "period" can be found in the FHIR base specification - section "Date Search".

22. facility

    Examples:

    GET [base]/DocumentReference?facility=http://ihe-d.de/CodeSystems/PatientBezogenenGesundheitsversorgung|KHS

    Usage notes: further information on searching by "facility" can be found in the FHIR base specification - section "Token Search".

23. setting

    Examples:

    GET [base]/DocumentReference?setting=http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen|INTZ

    Usage notes: further information on searching by "setting" can be found in the FHIR base specification - section "Token Search".

24. nlp-processing-status

    Examples:

    GET [base]/DocumentReference?nlp-processing-status=https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/CodeSystem/mii-cs-dokument-nlp-processing-status|unprocessed

    Usage notes: further information on searching by "nlp-processing-status" can be found in the FHIR base specification - section "Token Search".