eHealth Infrastructure
10.0.0 - release
eHealth Infrastructure
10.0.0 - release
This page is part of the FUT Infrastructure (v10.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Active as of 2026-08-06 |
{
"resourceType" : "OperationDefinition",
"id" : "-s-assigned-material-count",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition -s-assigned-material-count</b></p><a name=\"-s-assigned-material-count\"> </a><a name=\"hc-s-assigned-material-count\"> </a><p>URL: [base]/$assigned-material-count</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>ehealth-documentReference</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>Mandatory reference for general-material <code>ehealth-documentReference</code> from the Plan service.</p>\n</div></td></tr><tr><td>IN</td><td>group-by-careTeam</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>group the count by CareTeams present in the <code>Communication.participant.actor</code> references</p>\n</div></td></tr><tr><td>IN</td><td>date</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>Only count <code>ehealth-material-communications</code> where the <code>Communication.period</code> contains the date</p>\n</div></td></tr><tr><td>IN</td><td>status</td><td/><td>1..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Only count <code>ehealth-material-communications</code> with one of the given statuses</p>\n</div></td></tr></table></div>"
},
"url" : "http://ehealth.sundhed.dk/fhir/OperationDefinition/-s-assigned-material-count",
"version" : "10.0.0",
"name" : "assigned-material-count",
"title" : "Retrieve count of assignments for material",
"status" : "active",
"kind" : "operation",
"date" : "2026-08-06T13:29:38+00:00",
"publisher" : "Den telemedicinske infrastruktur (eHealth Infrastructure)",
"contact" : [
{
"name" : "Den telemedicinske infrastruktur (eHealth Infrastructure)",
"telecom" : [
{
"system" : "url",
"value" : "http://ehealth.sundhed.dk"
}
]
}
],
"description" : "This operation counts the number of material assignments (``ehealth-material-communication resources``) for a given ``ehealth-documentreference`` from the Plan service. This is done by performing an internal search using the given ehealth-documentReference, date and status parameters. Regardless of the given parameters, only ``ehealth-material-communication`` resources referring to an active ``ehealth-episodeofcare`` are counted. The group-by-careteam parameter determines whether a simple '_summary=count' search is performed or if all results should be fetched to extract and count based on participant CareTeam references.\r\n\r\n## Input\r\nThe operation has two mandatory input parameters:\r\n - An EHealthDocumentReference reference\r\n - One or more status codes\r\n\r\nAdditionally, there are two optional input parameters:\r\n - A boolean indicating whether to group the result by participant CareTeam references\r\n - A date parameter\r\n\r\n### EHealthDocumentReference reference\r\nA mandatory reference to an EHealthDocumentReference (general-material) in the plan service. Only ``ehealth-material-communication`` resources with the given reference in ``Communication.payload.content`` are counted.\r\n\r\n### Group-by-careTeam boolean\r\nThe group-by-careTeam parameter is optional. When not supplied by the user, it is assumed false. When it is set to true, the operation returns a count per CareTeam referenced as a participant in the matching ehealth-material-communication resources.\r\n\r\n### Date\r\nThe date parameter is optional, however, the count is always filtered by a date. If one is not given by the user, the date of execution is used instead. Only ``ehealth-material-communication`` resources whose ``Communication.period`` contains the used date are counted.\r\n\r\n### Status code list\r\nAt least one ``status`` code must be supplied by the user. Only ``ehealth-material-communications`` with one of the supplied status codes in ``Communication.status`` will be counted.\r\n\r\n## Output\r\nWhen supplied with valid inputs, the operation will return a Bundle resource with a single Parameters resource in its ``Bundle.entry`` list. The Parameters resource format depends on whether the group-by-careTeam parameter was true.\r\n\r\n### Output Parameters\r\nIf group-by-careTeam was false or not present. The Parameters resource will only contain a single parameter, named ``total`` with the value being the count of the ``ehealth-material-communication`` resources found to satisfy the given parameters.\r\n\r\nExample of output with group-by-careTeam as false or not present:\r\n```\r\n\"resource\": {\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [{\r\n \"name\": \"total\",\r\n \"valueInteger\": 42\r\n }]\r\n }]\r\n}\r\n```\r\n\r\nIf group-by-careTeam was true, the Parameters resource will contain a parameter for each CareTeam that is referenced in ``Communication.participant.actor`` in any of the matching ``ehealth-material-communication`` resources. The name of each parameter will be the reference value (CareTeam/[id]) of the CareTeam and the value will be the count of matching ``ehealth-material-communication`` resources that reference that CareTeam. It is worth noting that if an ``ehealth-material-communication`` has two (or more) distinct participant CareTeams, this will add to the count of each of them.\r\n\r\nExample of output with group-by-careTeam as true:\r\n```\r\n\"resource\": {\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [{\r\n \"name\": \"CareTeam/123\",\r\n \"valueInteger\": 5\r\n },\r\n {\r\n \"name\": \"CareTeam/456\",\r\n \"valueInteger\": 7\r\n }]\r\n }]\r\n}\r\n```\r\n",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "DK",
"display" : "Denmark"
}
]
}
],
"affectsState" : false,
"code" : "assigned-material-count",
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [
{
"name" : "ehealth-documentReference",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Mandatory reference for general-material ``ehealth-documentReference`` from the Plan service.",
"type" : "Reference"
},
{
"name" : "group-by-careTeam",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "group the count by CareTeams present in the ``Communication.participant.actor`` references",
"type" : "boolean"
},
{
"name" : "date",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Only count ``ehealth-material-communications`` where the ``Communication.period`` contains the date",
"type" : "dateTime"
},
{
"name" : "status",
"use" : "in",
"min" : 1,
"max" : "*",
"documentation" : "Only count ``ehealth-material-communications`` with one of the given statuses",
"type" : "string"
}
]
}
IG © 2021+ Den telemedicinske infrastruktur (eHealth Infrastructure). Package dk.ehealth.sundhed.fhir.ig.core#10.0.0 based on FHIR 4.0.1. Generated 2026-08-06
