ServiceRequest

Description

This entity represent a service request issued by a pracitioner for a patient. The requester is represented by a PractitionerRole. The subject of the ServiceRequest is a Patient.

Snapshot

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI1..1Extension(string)
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ0..1codeBindingFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
instantiatesCanonicalΣ0..*canonical(ActivityDefinition | PlanDefinition)
instantiatesUriΣ0..*uri
basedOnΣ I0..*Reference(CarePlan | ServiceRequest | MedicationRequest)
replacesΣ I0..*Reference(ServiceRequest)
requisitionΣ0..1Identifier
statusS Σ ?!1..1codeBinding
intentS Σ ?!1..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
priorityΣ0..1codeBinding
doNotPerformΣ ?!0..1boolean
codeΣ0..1CodeableConcept
orderDetailΣ I0..*CodeableConcept
quantityQuantityQuantity
quantityRatioRatio
quantityRangeRange
subjectS Σ I1..1Reference(Patient | Group | Location | Device)
encounterΣ I0..1Reference(Encounter)
occurrenceDateTimedateTime
occurrencePeriodPeriod
occurrenceTimingTiming
asNeededBooleanboolean
asNeededCodeableConceptCodeableConcept
authoredOnΣ0..1dateTime
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
performerTypeΣ0..1CodeableConcept
performerΣ I0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)
locationCodeΣ0..*CodeableConcept
locationReferenceΣ I0..*Reference(Location)
reasonCodeΣ0..*CodeableConcept
reasonReferenceΣ I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)
insuranceI0..*Reference(Coverage | ClaimResponse)
supportingInfoI0..*Reference(Resource)
specimenΣ I0..*Reference(Specimen)
bodySiteΣ0..*CodeableConcept
note0..*Annotation
patientInstructionΣ0..1string
relevantHistoryI0..*Reference(Provenance)

Click here for more information about the base FHIR ServiceRequest specification.

JSON structure

This is a template for the FHIR ServiceRequest. See table below for values description.

{
    "resourceType": "ServiceRequest",
    "id": "{logicalId}",
    "meta": {
        "versionId": "{versionId}",
        "lastUpdated": "{lastUpdatedDate}",
        "profile":  [
            "http://fhir.akinox.com/r4b/StructureDefinition/ServiceRequest"
        ]
    },
    "identifier":  [
        {
            "type": {
                "coding":  [
                    {
                        "code": "{identifierType}"
                    }
                ]
            },
            "value": "{businessIdentifier}"
        }
    ],
    "status": "{status}",
    "intent": "{intent}",
    "category":  [
        {
            "coding":  [
                {
                    "code": "{categoryCode}"
                }
            ],
            "text": "{categoryText}"
        }
    ],
    "subject": {
        "reference": "{subjectReference}",
        "identifier": {
            "type": {
                "coding":  [
                    {
                        "code": "{subjectIdentifierType}"
                    }
                ]
            },
            "value": "{subjectIdentifierValue}"
        }
    },
    "requester": {
        "reference": "{requesterReference}"
    }
}

Description of the values

Property Description
{logicalId} This is the logical identifier. It is a GUID.
{versionId} This is the version number of the Service Request. This version number is also incremented by the Akinox systems outside of changes done through this API.
{lastUpdatedDate} Last updated date of the Service Request
{identifierType} Identifier type for the ServiceRequest. Is a fixed value. (i.e. CaseId)
{businessIdentifier} Teleconsultation case number of the Service Request. This number is displayed in the Akinox user interface.
{status} Current status of the Service Request. Will have the value "draft" upon creation.
{intent} Intent of the Service Request. Has a fixed code set to "proposal".
{categoryCode} Clinical domain of the Service Request. The only supported code is dermatology for the moment. This value is not mandatory on creation
{categoryText} Clinical domain display text.
{subjectReference} The patient logical Id for which this Service Request is created.
{subjectIdentifierType} Identifier type for the Patient. Is a fixed value. (i.e. PCI, Patient Composed Identifier)
{subjectIdentifierValue} The patient identifier value for which this Service Request is created.
{requesterReference} The practitioner role that issued the Service Request.

Notes on typical FHIR errors

  • The identifier.type.coding.code must always be CaseId. Otherwise, the FHIR validation will raise an error. (it is caps sensitive)
    • Click here for further information regarding the types of identifier.
  • The meta.profile is mandatory for proper FHIR validation.

Search Parameters

Name Description
patient.identifier Business identifier (Patient Composed Identifier) of the of the referenced patient.
requester:PractitionerRole.practitioner.identifier Business identifier (License Number) of the referenced requester's practitioner.
requester:PractitionerRole.organization.partof.identifier Business identifier (MsssCode) of the referenced requester's organization parent.

See search examples