{
  "description": null,
  "_filename": "ImplementationGuide-se.electronichealth.fhir.merier.json",
  "package_name": "se.electronichealth.fhir.merier.r5",
  "definition": {
    "page": {
      "name": "toc.html",
      "page": [ ],
      "title": "Table of Contents",
      "sourceUrl": "toc.html",
      "generation": "html"
    },
    "resource": [ {
      "name": "AddOrganizationToEndpoint",
      "isExample": false,
      "reference": {
        "reference": "OperationDefinition/AddOrganizationToEndpoint"
      },
      "description": "Adds Endpoint to Organization.endpoint."
    }, {
      "name": "AddOrganizationToEndpoint request body with organization identifier",
      "isExample": true,
      "reference": {
        "reference": "Parameters/AddOrganizationToEndpoint-OrganizationIdentifier-RequestBody"
      },
      "description": "EducationEnvironment: Example of request body for AddOrganizationToEndpoint operation with organization number as organization identifier"
    }, {
      "name": "AddOrganizationToEndpoint response body with error message about invalid request format",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/b5e62914-fff8-46c8-b3fc-ed562d7d9688"
      },
      "description": "Example of response body with an OperationOutcome of failed AddOrganizationToEndpoint operation because of invalid format of identifier parameter"
    }, {
      "name": "AddOrganizationToEndpoint response body with error message that Endpoint does not exist",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/38be9f9d-b727-4dab-ad7e-f1325534fc6c"
      },
      "description": "Example of response body with an OperationOutcome of failed AddOrganizationToEndpoint operation because Endpoint does not exist"
    }, {
      "name": "AddOrganizationToEndpoint response body with information message that Organization already added",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/82dc7332-7b0f-4eb0-b045-924b5fd15d22"
      },
      "description": "Example of response body with an OperationOutcome of successful AddOrganizationToEndpoint operation because Organization was already added"
    }, {
      "name": "AddOrganizationToEndpoint response body with success message",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/6a9789ae-f2f7-4d48-bc24-d977f1534ac3"
      },
      "description": "Example of response body with an OperationOutcome of successful AddOrganizationToEndpoint operation"
    }, {
      "name": "API",
      "isExample": false,
      "reference": {
        "reference": "StructureDefinition/apilogical-er"
      },
      "description": "Klassen API håller information om funktion som möjliggör för mjukvaruapplikationer att begära tjänster från eller utbyta information mellan system."
    }, {
      "name": "API Specification (ER)",
      "isExample": false,
      "reference": {
        "reference": "StructureDefinition/api-specification-er"
      },
      "description": "This profile holds information about a set of capabilities defined in an API specification."
    }, {
      "name": "API-specifikation",
      "isExample": false,
      "reference": {
        "reference": "StructureDefinition/apispecifikation-logical-er"
      },
      "description": "Klassen API-specifikation håller information om en specifikation som beskriver de krav och regler som ett API ska följa."
    }, {
      "name": "Create Index Record (MeRI)",
      "isExample": false,
      "reference": {
        "reference": "OperationDefinition/create-index-record-operation-meri"
      },
      "description": "Creates an index record with a healthcare provider and patient."
    }, {
      "name": "CreateIndexRecord request body with coordination number and organization identifier",
      "isExample": true,
      "reference": {
        "reference": "Parameters/CreateIndexRecord-CoordinationNumber-RequestBody"
      },
      "description": "EducationEnvironment: Example of request body for CreateIndexRecord operation with coordination number as patient identifier"
    }, {
      "name": "CreateIndexRecord request body with invalid format of personal identity number",
      "isExample": true,
      "reference": {
        "reference": "Parameters/CreateIndexRecord-InvalidFormat-RequestBody"
      },
      "description": "Example of invalid request body for CreateIndexRecord operation because of wrongly formatted personal identity number of sole trader Organization - valueIdentifier.value of first parameter has 10 digit version of personal identity number instead of 12 - and invalid value of identifier system of second parameter"
    }, {
      "name": "CreateIndexRecord request body with personal identity number and organization identifier",
      "isExample": true,
      "reference": {
        "reference": "Parameters/CreateIndexRecord-PersonalIdentityNumber-RequestBody"
      },
      "description": "EducationEnvironment: Example of request body for CreateIndexRecord operation with personal identity number as patient identifier"
    }, {
      "name": "CreateIndexRecord response body with error message about duplicate record",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/54d7ac5d-380d-489a-b769-1ac5ed26eec7"
      },
      "description": "Example of response body with an OperationOutcome of successful CreateIndexRecord operation because index record already exists"
    }, {
      "name": "CreateIndexRecord response body with error messages about invalid request format",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/29d043b4-46ca-447a-9616-3abba3b47bb1"
      },
      "description": "Example of response body with an OperationOutcome of failed CreateIndexRecord operation because of invalid format of identifier parameter"
    }, {
      "name": "CreateIndexRecord response body with success message",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/f0b6e66c-794e-48a9-85f8-cb754e4d0091"
      },
      "description": "Example of response body with an OperationOutcome of successful CreateIndexRecord operation"
    }, {
      "name": "Diagnosis API specification",
      "profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/api-specification-er" ],
      "isExample": true,
      "reference": {
        "reference": "ActorDefinition/0d69f16c-afe1-4dbc-acab-3d98b5835e6a"
      },
      "description": "EducationEnvironment: Get ActorDefinition response body with ActorDefinition that can exchange diagnosis data"
    }, {
      "name": "Endpoint (ER)",
      "isExample": false,
      "reference": {
        "reference": "StructureDefinition/endpoint-er"
      },
      "description": "This profile holds information about a technical address to an API."
    }, {
      "name": "Endpoint Associated Server (ER)",
      "isExample": false,
      "reference": {
        "reference": "StructureDefinition/endpoint-associated-server-er"
      },
      "description": "Associated server of this endpoint."
    }, {
      "name": "Endpoint Consumer Actor (ER)",
      "isExample": false,
      "reference": {
        "reference": "ActorDefinition/endpoint-consumer-actor-er"
      },
      "description": "System that consumes information about the technical endpoints stored in the registry."
    }, {
      "name": "Endpoint Consumer Capabilities (ER)",
      "isExample": false,
      "reference": {
        "reference": "CapabilityStatement/endpoint-consumer-capabilities-er"
      }
    }, {
      "name": "Endpoint Payload Actor Definition (ER)",
      "isExample": false,
      "reference": {
        "reference": "StructureDefinition/endpoint-payload-actor-definition-er"
      },
      "description": "ActorDefinition that this payload is implementing."
    }, {
      "name": "Endpoint Registry Actor (ER)",
      "isExample": false,
      "reference": {
        "reference": "ActorDefinition/endpoint-registry-actor-er"
      },
      "description": "Registry for storing information about technical endpoints for retrieval of health information."
    }, {
      "name": "Endpoint Registry Capabilities (ER)",
      "isExample": false,
      "reference": {
        "reference": "CapabilityStatement/endpoint-registry-capabilities-er"
      }
    }, {
      "name": "Endpoint that implements vaccine and diagnosis API specifications",
      "profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er" ],
      "isExample": true,
      "reference": {
        "reference": "Endpoint/c933bcd8-ae65-41ce-ae6f-82477c770333"
      },
      "description": "EducationEnvironment: Get Endpoint response body with Endpoint that implements vaccine and diagnosis API specifications"
    }, {
      "name": "Endpoint that implements vaccine API specification",
      "profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er" ],
      "isExample": true,
      "reference": {
        "reference": "Endpoint/27a50668-ca2f-4333-9777-26a406944edd"
      },
      "description": "EducationEnvironment: Get Endpoint response body with Endpoint that implements vaccine API specification"
    }, {
      "name": "EndpointActorDefinitionSearchParameter",
      "isExample": false,
      "reference": {
        "reference": "SearchParameter/EndpointActorDefinitionSearchParameter"
      },
      "description": "Search parameter for querying Endpoints based on API specification valueCanonical reference of ActorDefinition in payloads."
    }, {
      "name": "Error codes (ER)",
      "isExample": false,
      "reference": {
        "reference": "ValueSet/er-error-codes"
      },
      "description": "Includes error and success messages for Endpoint Registry transactions."
    }, {
      "name": "Error codes (MeRI)",
      "isExample": false,
      "reference": {
        "reference": "ValueSet/meri-error-codes"
      },
      "description": "Includes error and success messages for Medical Record Indexing transactions."
    }, {
      "name": "Kategorier av API-specifikationer",
      "isExample": false,
      "reference": {
        "reference": "ValueSet/er-api-specification-categories"
      },
      "description": "Includes categories of API specifications."
    }, {
      "name": "Medical Record Index Actor (MeRI)",
      "isExample": false,
      "reference": {
        "reference": "ActorDefinition/medical-record-index-actor-meri"
      },
      "description": "Registry for storing indices of medical records of patients spread out in different systems at different care providers."
    }, {
      "name": "Medical Record Index Capabilities (MeRI)",
      "isExample": false,
      "reference": {
        "reference": "CapabilityStatement/medical-record-index-capabilities-meri"
      }
    }, {
      "name": "Medical Record Index Writer Actor (MeRI)",
      "isExample": false,
      "reference": {
        "reference": "ActorDefinition/medical-record-index-writer-actor-meri"
      },
      "description": "System responsible for registration and unregistration of medical record indices."
    }, {
      "name": "Medical Record Index Writer Capabilities (MeRI)",
      "isExample": false,
      "reference": {
        "reference": "CapabilityStatement/medical-record-index-writer-capabilities-meri"
      }
    }, {
      "name": "Medical Record Location Consumer Actor (MRL)",
      "isExample": false,
      "reference": {
        "reference": "ActorDefinition/medical-record-location-consumer-actor-mrl"
      },
      "description": "System that consumes endpoints where medical records can be found."
    }, {
      "name": "Medical Record Location Consumer Capabilities (MRL)",
      "isExample": false,
      "reference": {
        "reference": "CapabilityStatement/medical-record-location-consumer-capabilities-mrl"
      }
    }, {
      "name": "Medical Record Locator Actor (MRL)",
      "isExample": false,
      "reference": {
        "reference": "ActorDefinition/medical-record-locator-actor-mrl"
      },
      "description": "System that locates endpoints where medical records can be found."
    }, {
      "name": "Medical Record Locator Capabilities (MRL)",
      "isExample": false,
      "reference": {
        "reference": "CapabilityStatement/medical-record-locator-capabilities-mrl"
      }
    }, {
      "name": "Organization (ER)",
      "isExample": false,
      "reference": {
        "reference": "StructureDefinition/organization-er"
      },
      "description": "This profile holds information about organizations that can use endpoints."
    }, {
      "name": "Organization Endpoint Writer Actor (ER)",
      "isExample": false,
      "reference": {
        "reference": "ActorDefinition/organization-endpoint-writer-actor-er"
      },
      "description": "System that provides information about technical endpoints to the endpoint registry."
    }, {
      "name": "Organization Endpoint Writer Capabilities (ER)",
      "isExample": false,
      "reference": {
        "reference": "CapabilityStatement/organization-endpoint-writer-capabilities-er"
      }
    }, {
      "name": "Organization that is a healthcare provider",
      "profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/organization-er" ],
      "isExample": true,
      "reference": {
        "reference": "Organization/0173ca12-e676-4c52-a655-1edb444f7043"
      },
      "description": "EducationEnvironment: Get Organization response body with Organization that is a healthcare provider"
    }, {
      "name": "Patientjournal/personakt",
      "isExample": false,
      "reference": {
        "reference": "StructureDefinition/patientjournal-personakt-logical-er"
      },
      "description": "Klassen patientjournal/personakt håller information om förekomst av uppgifter om en vård- och omsorgstagare hos en viss organisation i ett visst system."
    }, {
      "name": "Protokoller som ändpunkter följer",
      "isExample": false,
      "reference": {
        "reference": "ValueSet/er-endpoint-connection-type"
      },
      "description": "Includes connection types of endpoints."
    }, {
      "name": "RemoveOrganizationFromEndpoint",
      "isExample": false,
      "reference": {
        "reference": "OperationDefinition/RemoveOrganizationFromEndpoint"
      },
      "description": "Removes Endpoint from Organization.endpoint."
    }, {
      "name": "RemoveOrganizationFromEndpoint request body with organization identifier",
      "isExample": true,
      "reference": {
        "reference": "Parameters/RemoveOrganizationFromEndpoint-OrgIdentifier-RequestBody"
      },
      "description": "EducationEnvironment: Example of request body for RemoveOrganizationFromEndpoint operation with organization number as organization identifier"
    }, {
      "name": "RemoveOrganizationFromEndpoint response body with information message that organization already removed",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/50f1a372-47a4-4b41-aacf-e7ad3fb81e8e"
      },
      "description": "Example of response body with an OperationOutcome of successful RemoveOrganizationFromEndpoint operation because Organization was not found in Endpoint"
    }, {
      "name": "RemoveOrganizationFromEndpoint response body with success message",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/0cf0f00a-846e-43fd-b17f-afe665e9e5e4"
      },
      "description": "Example of response body with an OperationOutcome of successful RemoveOrganizationFromEndpoint operation"
    }, {
      "name": "SearchEndpoint",
      "isExample": false,
      "reference": {
        "reference": "OperationDefinition/SearchEndpoint"
      },
      "description": "Search for active Endpoints where healthcare providers, which a patient has been registered at, make patient data available."
    }, {
      "name": "SearchEndpoint request body with diagnosis API specification for patient with coordination number",
      "isExample": true,
      "reference": {
        "reference": "Parameters/SearchEndpoint-DiagnosisForCoordinationNumber-RequestBody"
      },
      "description": "EducationEnvironment: Example of request body for SearchEndpoint operation with coordination number as patient identifier and canonical ID of API specification for diagnosis data"
    }, {
      "name": "SearchEndpoint request body with diagnosis API specification for patient with personal identity number",
      "isExample": true,
      "reference": {
        "reference": "Parameters/SearchEndpoint-DiagnosisForPersonalIdentityNumber-RequestBody"
      },
      "description": "EducationEnvironment: Example of request body for SearchEndpoint operation with personal identity number as patient identifier and canonical ID of API specification for diagnosis data"
    }, {
      "name": "SearchEndpoint request body with vaccine and diagnosis API specifications",
      "isExample": true,
      "reference": {
        "reference": "Parameters/SearchEndpoint-VaccineAndDiagnosis-RequestBody"
      },
      "description": "EducationEnvironment: Example of request body for SearchEndpoint operation with personal identity number as patient identifier and canonical IDs of API specifications for vaccine data and diagnosis data"
    }, {
      "name": "SearchEndpoint request body with vaccine API specification",
      "isExample": true,
      "reference": {
        "reference": "Parameters/SearchEndpoint-VaccineForPersonalIdentityNumber-RequestBody"
      },
      "description": "EducationEnvironment: Example of request body for SearchEndpoint operation with personal identity number as patient identifier and canonical ID of API specification for vaccine data"
    }, {
      "name": "SearchEndpoint response body with error message about invalid format of personal identity number",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/da2501bb-9efb-41a9-b0c7-266ab9dc6c2a"
      },
      "description": "Example of response body with an OperationOutcome of failed SearchEndpoint operation because of invalid format of identifier value"
    }, {
      "name": "SearchEndpoint response body with error message about invalid identifier system",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/1c227876-4b09-4adf-8bb0-629973bce4f6"
      },
      "description": "Example of response body with an OperationOutcome of failed SearchEndpoint operation because of invalid identifier system"
    }, {
      "name": "SearchEndpoint response body with result for patient with personal identity number and vaccine API specification",
      "isExample": true,
      "reference": {
        "reference": "Bundle/102a4565-ff8c-489c-9ce0-392e56451126"
      },
      "description": "EducationEnvironment: Example of response body for SearchEndpoint query operation with Organizations and Endpoints. The Endpoints are referenced to in the corresponding Organization.endpoint elements."
    }, {
      "name": "Statusar på ändpunkt",
      "isExample": false,
      "reference": {
        "reference": "ValueSet/er-endpoint-statuses"
      },
      "description": "Includes statuses of endpoints."
    }, {
      "name": "System",
      "isExample": false,
      "reference": {
        "reference": "StructureDefinition/system-logical-er"
      },
      "description": "Klassen system håller information om enheter som tillsammans bildar en helhet med en viss funktion. I denna modell avses endast system som använder eller tillhandahåller API:er via ändpunkter."
    }, {
      "name": "Typ av organisation",
      "isExample": false,
      "reference": {
        "reference": "ValueSet/er-organization-type"
      },
      "description": "Includes types of organizations."
    }, {
      "name": "Typ av server",
      "isExample": false,
      "reference": {
        "reference": "ValueSet/er-server-types"
      },
      "description": "Includes types of servers."
    }, {
      "name": "Unregister Index Record (MeRI)",
      "isExample": false,
      "reference": {
        "reference": "OperationDefinition/unregister-index-record-operation-meri"
      },
      "description": "Unregisters an index record of a healthcare provider and patient."
    }, {
      "name": "UnregisterIndexRecord request body with coordination number and organization identifier",
      "isExample": true,
      "reference": {
        "reference": "Parameters/UnregisterIndexRecord-CoordinationNumber-RequestBody"
      },
      "description": "EducationEnvironment: Example of request body for UnregisterIndexRecord operation with coordination number as patient identifier"
    }, {
      "name": "UnregisterIndexRecord request body with invalid format of organization identifier",
      "isExample": true,
      "reference": {
        "reference": "Parameters/UnregisterIndexRecord-InvalidFormat-RequestBody"
      },
      "description": "Example of invalid request body for UnregisterIndexRecord operation because of wrongly formatted organization identifier of healthcare provider - valueIdentifier.value has 9 digits instead of 10 - and invalid value of identifier system of patient parameter"
    }, {
      "name": "UnregisterIndexRecord request body with personal identity number and organization identifier",
      "isExample": true,
      "reference": {
        "reference": "Parameters/UnregisterIndexRecord-PersonalIdentityNumber-RequestBody"
      },
      "description": "EducationEnvironment: Example of request body for UnregisterIndexRecord operation with personal identity number as patient identifier"
    }, {
      "name": "UnregisterIndexRecord response body with error messages about invalid request format",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/c88bc3e4-3f37-4d1e-bf53-0556da1c0124"
      },
      "description": "Example of response body with an OperationOutcome of failed UnregisterIndexRecord operation because of invalid format of identifier parameter"
    }, {
      "name": "UnregisterIndexRecord response body with information message that index record does not exist",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/f434502d-363f-4374-816d-3c3795fc187d"
      },
      "description": "Example of response body with an OperationOutcome of successful UnregisterIndexRecord operation because index record does not exist"
    }, {
      "name": "UnregisterIndexRecord response body with success message",
      "isExample": true,
      "reference": {
        "reference": "OperationOutcome/f1fe77eb-626b-49d8-be65-e8fc9ab3d54a"
      },
      "description": "Example of response body with an OperationOutcome of successful UnregisterIndexRecord operation"
    }, {
      "name": "Vaccine API specification",
      "profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/api-specification-er" ],
      "isExample": true,
      "reference": {
        "reference": "ActorDefinition/597a4df4-d4ee-45c6-880b-6301a9369d32"
      },
      "description": "EducationEnvironment: Get ActorDefinition response body with ActorDefinition that can exchange vaccine data"
    }, {
      "name": "Ändpunkt",
      "isExample": false,
      "reference": {
        "reference": "StructureDefinition/andpunkt-logical-er"
      },
      "description": "Klassen ändpunkt håller information om teknisk adress till API implementerat på fysisk enhet."
    } ],
    "parameter": [ {
      "code": {
        "code": "copyrightyear",
        "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters"
      },
      "value": "2025+"
    }, {
      "code": {
        "code": "releaselabel",
        "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters"
      },
      "value": "ci-build"
    } ]
  },
  "date": null,
  "publisher": null,
  "fhirVersion": [ "5.0.0" ],
  "dependsOn": [ {
    "id": "hl7_fhir_r5_core",
    "uri": "http://hl7.org/fhir/ImplementationGuide/fhir",
    "version": "5.0.0",
    "packageId": "hl7.fhir.r5.core"
  } ],
  "name": "SwedishMedicalRecordIndexAndEndpointRegistry",
  "type": null,
  "experimental": null,
  "resourceType": "ImplementationGuide",
  "title": "Swedish Medical Record Index And Endpoint Registry",
  "package_version": "0.1.2-beta",
  "status": "draft",
  "id": "df1c030b-3c45-4021-a998-c7b08a5dd9f0",
  "kind": null,
  "url": "http://electronichealth.se/fhir/NDI/ImplementationGuide/se.electronichealth.fhir.merier",
  "version": "0.1.0",
  "packageId": "se.electronichealth.fhir.merier"
}