Fut1 23141 ccr0320 oa1 documentation#302
Merged
anjak-systematic merged 8 commits intoJun 24, 2026
Merged
Conversation
added 4 commits
June 22, 2026 13:09
# Conflicts: # input/pagecontent/changelog.md
sysMATGS
approved these changes
Jun 24, 2026
| }, { | ||
| "name": "assigned-material-count", | ||
| "definition": "https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-assigned-material-count", | ||
| "documentation": "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. 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##Input\r\nThe operation has two mandatory input parameters:\r\n - An EHealthDocumentReference reference\r\n - Minimum one status code\r\nAdditionally, it 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### 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### 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### 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### 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## 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### 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\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\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 ```" |
Contributor
There was a problem hiding this comment.
"Additionally, it there are two optional input parameters" , jeg tror der er et ord for meget eller noget here
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
release-3.5.0. Only release branches should targetmaster. For more details, see here.The IG is materialised as a website automatically by CI, and can be found here.