Kirjaa välityspyyntö

Välityspyynnön HTTP pyyntö (request)

Välityspyyntö lähetetään kysely- ja välityspalvelulle HTTP POST-pyyntönä operaatiolla $relay-request. Välityspyyntö kuvataan FHIR standardin CommunicationRequest-resurssilla. Voit lukea CommunicationRequest-resurssista lisää FHIR-standardista.

Rajapinnan OperationDefinition-kuvaus

Invocations

URL: [base]/$relay-request

This operation changes content

Parameters (In)

NameCardinalityTypeDocumentation
communicationrequested1..1CommunicationRequest(Valityspyynto)

Välityspyyntö

Sekvenssikaavio



HTTP pyynnön header

HTTP-pyynnön header-tiedot on kuvattu Kanta-palvelujen yhteisessä FHIR- ja REST-soveltamisoppaassa. Voit lukea lisää oppaan sivulla Kanta HTTP header-tiedot FHIR-rajapinnassa

Kannattaa kuitenkin huomioida erityisesti headerin kenttä X-Request-Id, jonka arvo on oltava yksilöllinen jokaiselle http-pyynnölle.

Pyynnön HTTP header esimerkki

POST [base][api] HTTP/1.1 
Accept: application/fhir+json
Authorization: Bearer eyJraWQiOiJyc2ExIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJhMTcxYjFmNC04ZDkwLT...
X-Request-Id: 1.2.246.10.1.20241208102307.93.2023.11023072024880604629
Content-Type: application/x-www-form-urlencoded

HTTP pyynnön body

Välityspyynnön tiedot välitetään HTTP pyynnön body-osuudessa Parameters-resurssin avulla. Voit lukea lisää Parameters-resurssista FHIR-stadnardista.

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..0uri
language0..1codeBinding
text1..1Narrative
contained0..0Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..0Identifier
basedOnΣ0..0Reference(Resource)
replacesΣ0..0Reference(CommunicationRequest)
groupIdentifierΣ0..0Identifier
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConcept
category0..0CodeableConcept
priorityΣ0..0codeBinding
doNotPerformΣ ?!0..0boolean
medium0..0CodeableConcept
id0..0string
extensionI0..0Extension
referenceΣ I0..0string
typeΣ0..0uriBinding
id0..0string
extensionI0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ0..0Period
assignerΣ0..0Reference(Organization)
displayΣ0..1string
about0..0Reference(Resource)
encounterΣ0..0Reference(Encounter)
id0..0string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
id0..0string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
id0..0string
extensionI0..0Extension
referenceΣ I0..0string
typeΣ0..0uriBinding
id0..0string
extensionI0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ0..0Period
assignerΣ0..0Reference(Organization)
displayΣ0..0string
contentReferenceReference(Resource)
authoredOnΣ0..0dateTime
id0..0string
extensionI0..0Extension
referenceΣ I0..0string
typeΣ0..0uriBinding
id0..0string
extensionI0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ0..0Period
assignerΣ0..0Reference(Organization)
displayΣ0..1string
id0..0string
extensionI0..0Extension
referenceΣ I0..0string
typeΣ0..0uriBinding
id0..0string
extensionI0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1stringBinding
periodΣ0..0Period
assignerΣ0..0Reference(Organization)
displayΣ0..1string
id0..0string
extensionI0..0Extension
referenceΣ I0..0string
typeΣ0..0uriBinding
id0..0string
extensionI0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ0..0Period
assignerΣ0..0Reference(Organization)
displayΣ0..1string
id0..0string
extensionI0..0Extension
id0..0string
extensionI0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..0boolean
textΣ0..0string
reasonReferenceΣ0..0Reference(Condition | Observation | DiagnosticReport | DocumentReference)
note0..0Annotation
{
    "resourceType": "Parameters",
    "parameter":  [
        {
            "name": "Valityspyynto",
            "resource": {
                "resourceType": "CommunicationRequest",
                "id": "example",
                "meta": {
                    "profile":  [
                        "https://kvp.kanta.fi/fhir/StructureDefinition/valityspyynto"
                    ]
                },
                "text": {
                    "status": "generated",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Esimerkkiresurssi välityspyynnöstä. </div>"
                },
                "identifier":  [
                    {
                        "system": "urn:ietf:rfc:3986",
                        "value": "urn:uuid:0b0a55d2-799a-45f5-a161-6a4a5faad1f5"
                    }
                ],
                "status": "active",
                "subject": {
                    "identifier": {
                        "system": "urn:oid:1.2.246.21",
                        "value": "090878-915W"
                    },
                    "display": "Mauri Antero, Numminen"
                },
                "payload":  [
                    {
                        "contentReference": {
                            "identifier": {
                                "system": "urn:ietf:rfc:3986",
                                "value": "urn:oid:1.2.246.10.10345159"
                            }
                        },
                        "modifierExtension":  [
                            {
                                "url": "https://kvp.kanta.fi/fhir/StructureDefinition/Nakymakoodi",
                                "valueCoding": {
                                    "system": "urn:oid:1.2.246.537.6.12.2002",
                                    "code": "151",
                                    "display": "Lääkärinlausunto ajokyvystä"
                                }
                            }
                        ]
                    }
                ],
                "requester": {
                    "identifier": {
                        "system": "urn:oid:1.2.246.537.26",
                        "value": "10005398475"
                    },
                    "display": "Lääkäri, Luttinen"
                },
                "recipient":  [
                    {
                        "identifier": {
                            "system": "urn:oid:1.2.246.537.6.40191.201701",
                            "value": "urn:oid:1.2.246.10.10317159"
                        },
                        "display": "Traficom"
                    }
                ],
                "reasonCode":  [
                    {
                        "coding":  [
                            {
                                "system": "urn:oid:1.2.246.537.6.40192.2012",
                                "code": "1",
                                "display": "Asiakkaan toimeksianto"
                            }
                        ]
                    }
                ]
            }
        }
    ]
}