ServiceRequest

ServiceRequest creates an order with all neccessary informations.

Create

Endpoint

POST <serveraddress>/fhir/ServiceRequest

This returns the created ServiceRequest and an url in the location header.

All CodeableConcepts are bound to an individual CodeSystem. ValueSet can be used to query these codes.

Patient, Condition, Medication and Specimens shall be submitted as contained resources.

Notification

To get information about the status of the process, an notification url can be submitted in an extension.
At each workflow step, the current DiagnosticReport is sent to this URL.

Structures

ServiceRequest

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
PatientCreate1..1Resource
ConditionCreate0..1Resource
MedicationCreate0..1Resource
SpecimenCreate0..*Resource
NotificationUrlI0..1Extension(url)
modifierExtension?! I0..*Extension
identifierΣ0..1Identifier
instantiatesCanonicalΣ0..0canonical(ActivityDefinition | PlanDefinition)
instantiatesUriΣ0..0uri
basedOnΣ I0..0Reference(CarePlan | ServiceRequest | MedicationRequest)
replacesΣ I0..0Reference(ServiceRequest)
requisitionΣ0..0Identifier
statusΣ ?!1..1codeBindingPattern
intentΣ ?!1..1codeBindingPattern
categoryΣ0..0CodeableConcept
priorityΣ0..0codeBinding
doNotPerformΣ ?!0..0boolean
id0..1string
extensionI0..*Extension
codingΣ0..1Coding
textΣ0..0string
orderDetailΣ I0..0CodeableConcept
subjectΣ I1..1Reference(PatientCreate)
encounterΣ I0..0Reference(Encounter)
authoredOnΣ0..0dateTime
requesterΣ I0..1Reference(Organization)
performerTypeΣ0..0CodeableConcept
performerΣ I0..0Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)
locationCodeΣ0..0CodeableConcept
locationReferenceΣ I0..0Reference(Location)
id0..1string
extensionI0..*Extension
codingΣ0..1Coding
textΣ0..0string
reasonReferenceΣ I0..0Reference(Condition | Observation | DiagnosticReport | DocumentReference)
insuranceI0..0Reference(Coverage | ClaimResponse)
supportingInfoI0..2Reference(ConditionCreate | MedicationCreate)
specimenΣ I0..*Reference(SpecimenCreate)
bodySiteΣ0..0CodeableConcept
note0..0Annotation
patientInstructionΣ0..0string
relevantHistoryI0..0Reference(Provenance)

Patient

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..1Identifier
activeΣ ?!0..0boolean
nameΣ0..0HumanName
telecomΣ I0..0ContactPoint
genderΣ0..0codeBinding
birthDateΣ0..0date
addressΣ0..0Address
maritalStatus0..0CodeableConceptBinding
photoI0..0Attachment
generalPractitionerI0..0Reference(Organization | Practitioner | PractitionerRole)
managingOrganizationΣ I0..0Reference(Organization)

Condition

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..0Identifier
clinicalStatusΣ ?! I0..0CodeableConceptBinding
verificationStatusΣ ?! I0..0CodeableConceptBinding
category0..0CodeableConceptBinding
severity0..0CodeableConceptBinding
id0..1string
extensionI0..*Extension
codingΣ0..1Coding
textΣ0..0string
bodySiteΣ0..0CodeableConcept
subjectΣ I1..1Reference(PatientCreate)
encounterΣ I0..0Reference(Encounter)
recordedDateΣ0..0dateTime
recorderΣ I0..0Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
asserterΣ I0..0Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
note0..0Annotation

Medication

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..0Identifier
id0..1string
extensionI0..*Extension
codingΣ0..1Coding
textΣ0..0string
statusΣ ?!0..0codeBinding
manufacturerΣ I0..0Reference(Organization)
form0..0CodeableConcept
amountΣ I0..0Ratio

Specimen

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..1Identifier
accessionIdentifierΣ0..0Identifier
statusΣ ?!0..0codeBinding
id0..1string
extensionI0..*Extension
codingΣ0..1Coding
textΣ0..0string
subjectΣ I0..0Reference(Patient | Group | Device | Substance | Location)
receivedTimeΣ0..0dateTime
parentI0..0Reference(Specimen)
requestI0..0Reference(ServiceRequest)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
collectorΣ I0..0Reference(Practitioner | PractitionerRole)
collectedDateTimedateTime
durationΣ I0..0Duration
quantityI0..0SimpleQuantity
method0..0CodeableConcept
bodySite0..0CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifierΣ0..0Identifier
description0..0string
type0..0CodeableConcept
capacityI0..0SimpleQuantity
specimenQuantityI0..1SimpleQuantityBinding
conditionΣ0..0CodeableConceptBinding
note0..0Annotation

NotificationUrl extension

id0..1string
extensionI0..0Extension
url1..1uriFixed Value
valueUrlurl

Example

{
    "resourceType": "ServiceRequest",
    "id": "servicerequest-example-create",
    "contained":  [
        {
            "resourceType": "Patient",
            "id": "patient-example-create",
            "identifier":  [
                {
                    "system": "http://www.acme.com/fhir/NamingSystem/patient-identifier",
                    "value": "patient-extern-123"
                }
            ]
        },
        {
            "resourceType": "Condition",
            "id": "condition-example-create",
            "code": {
                "coding":  [
                    {
                        "code": "DIAGNOSIS-1",
                        "system": "http://www.qualitype.de/samples/fhir/CodeSystem/diagnoses"
                    }
                ]
            },
            "subject": {
                "reference": "#patient-example-create"
            }
        },
        {
            "resourceType": "Medication",
            "id": "medication-example-create",
            "code": {
                "coding":  [
                    {
                        "code": "MEDIKATION-1",
                        "system": "http://www.qualitype.de/samples/fhir/CodeSystem/medications"
                    }
                ]
            }
        },
        {
            "resourceType": "Specimen",
            "id": "specimen-example-create",
            "identifier":  [
                {
                    "system": "http://www.acme.com/fhir/NamingSystem/specimen-identifier",
                    "value": "sample-extern-123"
                }
            ],
            "type": {
                "coding":  [
                    {
                        "code": "SAMPLETYPE-1",
                        "system": "http://www.qualitype.de/samples/fhir/CodeSystem/sampletypes"
                    }
                ]
            },
            "collection": {
                "collectedDateTime": "2023-07-01T12:00:00+00:00"
            },
            "container":  [
                {
                    "specimenQuantity": {
                        "value": 10,
                        "code": "mL",
                        "system": "http://www.qualitype.de/samples/fhir/CodeSystem/units"
                    }
                }
            ]
        }
    ],
    "extension":  [
        {
            "url": "http://www.qualitype.de/samples/fhir/StructureDefinition/notification-url",
            "valueUrl": "http://www.acme.com/notifyme"
        }
    ],
    "identifier":  [
        {
            "system": "http://www.acme.com/fhir/NamingSystem/servicerequest-identifier",
            "value": "order-extern-123"
        }
    ],
    "status": "active",
    "intent": "order",
    "code": {
        "coding":  [
            {
                "code": "GOAL-1",
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/goals"
            }
        ]
    },
    "subject": {
        "reference": "#patient-example-create"
    },
    "requester": {
        "reference": "Organization/acme"
    },
    "reasonCode":  [
        {
            "coding":  [
                {
                    "code": "INDICATION-1",
                    "system": "http://www.qualitype.de/samples/fhir/CodeSystem/indications"
                }
            ]
        }
    ],
    "supportingInfo":  [
        {
            "reference": "#condition-example-create"
        },
        {
            "reference": "#medication-example-create"
        }
    ],
    "specimen":  [
        {
            "reference": "#specimen-example-create"
        }
    ]
}