Page Status: draft updated 2025-04-04

Use cases

This section contains guidance for using the API to communicate with the Swedish National Catalog of Organization, Offerings and Contracts. Each page describes constraints that apply when interacting with a certain profile as well as examples of request and response bodies.

The examples show how the profiles might be filled in when they represent a certain use case. To see how the profiles are connected to form the data structure of the Swedish National Catalog of Organization, Offerings and Contracts, see the collection of examples below.

Areas

Organization and business

Organization

Organization
{
    "resourceType": "Organization",
    "id": "OrganizationInstance1",
    "meta": {
        "profile":  [
            "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization"
        ]
    },
    "identifier":  [
        {
            "system": "urn:oid:2.5.4.97",
            "value": "5565932521"
        }
    ],
    "extension":  [
        {
            "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension",
            "valueBoolean": true
        },
        {
            "valuePeriod": {
                "start": "2000-06-14"
            },
            "url": "http://hl7.org/fhir/StructureDefinition/organization-period"
        },
        {
            "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationLegalFormExtension",
            "valueCoding": {
                "code": "49",
                "system": "http://electronichealth.se/CodeSystem/skatteverket-jurform",
                "display": "Övriga aktiebolag"
            }
        },
        {
            "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationOwnershipExtension",
            "valueCoding": {
                "code": "42",
                "system": "http://electronichealth.se/CodeSystem/organization-ownership-scb",
                "display": "Privat svenskkontrollerade enheter med koncerntillhörighet"
            }
        }
    ],
    "type":  [
        {
            "coding":  [
                {
                    "code": "143591000052106",
                    "system": "http://snomed.info/sct",
                    "version": "http://snomed.info/sct/45991000052106",
                    "display": "vårdgivare"
                }
            ]
        }
    ],
    "contact":  [
        {
            "address": {
                "line":  [
                    "Wollmar Yxkullsgatan 25"
                ],
                "postalCode": "118 50",
                "city": "Stockholm",
                "country": "Sverige"
            },
            "extension":  [
                {
                    "valuePeriod": {
                        "start": "06/13/2000 23:00:00"
                    },
                    "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContactPeriodExtension"
                }
            ],
            "purpose": {
                "coding":  [
                    {
                        "code": "ADMIN",
                        "system": "http://terminology.hl7.org/CodeSystem/contactentity-type",
                        "display": "Administrativt"
                    }
                ]
            }
        },
        {
            "extension":  [
                {
                    "valuePeriod": {
                        "start": "12/31/2021 23:00:00"
                    },
                    "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContactPeriodExtension"
                }
            ],
            "telecom":  [
                {
                    "value": "https://meliva.se/vardcentral-soderdoktorn/",
                    "system": "url"
                }
            ],
            "purpose": {
                "coding":  [
                    {
                        "code": "PATINF",
                        "system": "http://terminology.hl7.org/CodeSystem/contactentity-type",
                        "display": "Patient"
                    }
                ]
            }
        }
    ],
    "name": "Meliva Vårdcentral Söderdoktorn AB"
}

Organizational unit

Organization
{
    "resourceType": "Organization",
    "id": "OrganizationalUnitInstance1",
    "meta": {
        "profile":  [
            "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit"
        ]
    },
    "identifier":  [
        {
            "system": "urn:oid:1.2.752.29.4.19",
            "value": "SE2321000016-114G"
        }
    ],
    "extension":  [
        {
            "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension",
            "valueBoolean": true
        },
        {
            "valuePeriod": {
                "start": "06/13/2000 23:00:00"
            },
            "url": "http://hl7.org/fhir/StructureDefinition/organization-period"
        }
    ],
    "type":  [
        {
            "coding":  [
                {
                    "code": "43741000",
                    "system": "http://snomed.info/sct",
                    "version": "http://snomed.info/sct/45991000052106",
                    "display": "vårdenhet"
                }
            ]
        }
    ],
    "contained":  [
        {
            "resourceType": "HealthcareService",
            "id": "BusinessInstance1",
            "meta": {
                "profile":  [
                    "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOBusiness"
                ]
            },
            "providedBy": {
                "reference": "#"
            },
            "category":  [
                {
                    "coding":  [
                        {
                            "code": "1502",
                            "system": "urn:oid:1.2.752.129.2.2.1.3",
                            "display": "Allmänmedicin"
                        }
                    ]
                }
            ],
            "location":  [
                {
                    "reference": "Location/PositionLocationInstance1"
                },
                {
                    "reference": "Location/CountyLocationInstance1"
                },
                {
                    "reference": "Location/MunicipalityLocationInstance1"
                },
                {
                    "reference": "Location/AddressLocationInstance1"
                }
            ],
            "availableTime":  [
                {
                    "daysOfWeek":  [
                        "mon",
                        "tue",
                        "wed",
                        "thu",
                        "fri"
                    ],
                    "availableStartTime": "08:00:00",
                    "availableEndTime": "17:00:00"
                }
            ]
        }
    ],
    "contact":  [
        {
            "address": {
                "line":  [
                    "Wollmar Yxkullsgatan 25"
                ],
                "postalCode": "118 50",
                "city": "Stockholm",
                "country": "Sverige"
            },
            "extension":  [
                {
                    "valuePeriod": {
                        "start": "06/13/2000 23:00:00"
                    },
                    "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContactPeriodExtension"
                }
            ],
            "purpose": {
                "coding":  [
                    {
                        "code": "ADMIN",
                        "system": "http://terminology.hl7.org/CodeSystem/contactentity-type",
                        "display": "Administrativt"
                    }
                ]
            }
        },
        {
            "extension":  [
                {
                    "valuePeriod": {
                        "start": "12/31/2021 23:00:00"
                    },
                    "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContactPeriodExtension"
                }
            ],
            "telecom":  [
                {
                    "value": "https://meliva.se/vardcentral-soderdoktorn/",
                    "system": "url"
                }
            ],
            "purpose": {
                "coding":  [
                    {
                        "code": "PATINF",
                        "system": "http://terminology.hl7.org/CodeSystem/contactentity-type",
                        "display": "Patient"
                    }
                ]
            }
        }
    ],
    "name": "Meliva vårdcentral Söderdoktorn",
    "partOf": {
        "reference": "Organization/OrganizationInstance1"
    }
}

Business

Offerings

Service

Eligibility group

Agreement

Contract

Organization affiliation

Location