FHIR:Vprepub-1.0 FHIR IG STU3 - Bewerkingsoverzicht

Pieter Edelman: MM-3308: Correct the link to paging in the FHIR spec

2022-07-27T10:42:59Z

MM-3308: Correct the link to paging in the FHIR spec

← Oudere versie		Versie van 27 jul 2022 10:42
Regel 171:		Regel 171:

	====Paging====		====Paging====
	Servers MAY use [https://www.hl7.org/fhir/stu3/~~search~~.html#~~count~~ paging] for performance reasons. Client SHALL support this mechanism to prevent loss of information.		Servers MAY use [https://www.hl7.org/fhir/stu3/http.html#paging paging] for performance reasons. Client SHALL support this mechanism to prevent loss of information.

	== Usage of the {{fhir\|.id}}, {{fhir\|.identifier}} and {{fhir\|.fullUrl}} elements in FHIR instances ==		== Usage of the {{fhir\|.id}}, {{fhir\|.identifier}} and {{fhir\|.fullUrl}} elements in FHIR instances ==

Pieter Edelman: MM-3254: Add guidance on the absence of the mustSupport flag

2022-06-27T14:27:14Z

MM-3254: Add guidance on the absence of the mustSupport flag

← Oudere versie		Versie van 27 jun 2022 14:27
Regel 81:		Regel 81:

	For example, the profile nl-core-address defines a relationship with [https://simplifier.net/NictizSTU3-Zib2017/nl-core-address/~mappings with four functional definitions], one of which is [https://zibs.nl/wiki/AddressInformation-v1.0(2017EN) AddressInformation-v1.0(2017EN)]. This mapping is identified within the profile using 'hcim-addressinformation-v1.0-2017EN'. Looking at the {{fhir\|Address.city}} element in this profile, one of the mappings is defined as 'hcim-addressinformation-v1.0-2017EN:NL-CM:20.5.3'. This reveals that this element implements (amongst others) the concept from the HCIM AddressInformation-v1.0(2017EN) described using ID 'NL-CM:20.5.3'.		For example, the profile nl-core-address defines a relationship with [https://simplifier.net/NictizSTU3-Zib2017/nl-core-address/~mappings with four functional definitions], one of which is [https://zibs.nl/wiki/AddressInformation-v1.0(2017EN) AddressInformation-v1.0(2017EN)]. This mapping is identified within the profile using 'hcim-addressinformation-v1.0-2017EN'. Looking at the {{fhir\|Address.city}} element in this profile, one of the mappings is defined as 'hcim-addressinformation-v1.0-2017EN:NL-CM:20.5.3'. This reveals that this element implements (amongst others) the concept from the HCIM AddressInformation-v1.0(2017EN) described using ID 'NL-CM:20.5.3'.

			===Absence of the {{fhir\|mustSupport}} flag===
			The basic notion for any element or extension in a profile, most specifically when it has a mapping to a functional definition, is: provide what you have, and support what you can. At the zib profiling level it is not known what the exact context of use will be. This means that a formal FHIR [http://hl7.org/fhir/stu3/elementdefinition-definitions.html#ElementDefinition.mustSupport {{fhir\|mustSupport}}] flag would possibly not hold in every imaginable use case. Therefore, {{fhir\|mustSupport}} flags are absent in zib profiles. The exact requirements for the use case at hand should not be inferred from the zib profiles, but from the functional specification that is part of any information standard.

			An information standard may provide additional use case or transaction specific profiles, which constrain cardinalities and apply {{fhir\|mustSupport}} as applicable, for extra implementation guidance.

	==Profile use and declaration==		==Profile use and declaration==

Pieter Edelman: MM-2759: Add guidance on how to and how not to reference resources in search results

2022-06-27T14:00:54Z

MM-2759: Add guidance on how to and how not to reference resources in search results

← Oudere versie		Versie van 27 jun 2022 14:00
Regel 161:		Regel 161:
	===Search results===		===Search results===
	====Including referenced resources====		====Including referenced resources====
	Servers may not support read interactions, but all references from search results need to be resolvable (see [[#Use of the reference datatype]]). Therefore servers MAY choose to include the referenced resources in the ''searchset'' Bundle, even if the client didn't use any <code>_include</code> parameters. These resources SHALL have <code>Bundle.entry.mode</code> set to "''include''". Servers SHOULD NOT use contained resources for this purpose.		Servers may not support read interactions, but all references from search results need to be resolvable (see [[#Use of the reference datatype]]). Therefore servers MAY choose to include the referenced resources in the ''searchset'' Bundle, even if the client didn't use any <code>_include</code> parameters ([[FHIR:Vprepub-1.0 Search result examples#Server doesn't support read operations\|example]]). These resources SHALL have <code>Bundle.entry.mode</code> set to "''include''". Servers SHOULD NOT use contained resources for this purpose.

			The [[FHIR:Vprepub-1.0 Search result examples\|examples page]] illustrates how servers can provide resolveable references in different situations.

	====Paging====		====Paging====
Regel 207:		Regel 209:

	==== Example ====		==== Example ====
	Consider a client that wants to send a new Observation instance to a server and simultaneously link it to an existing Task instance. This can be done using a transaction Bundle:		Consider a client that wants to send a new Observation instance to a server and simultaneously link it to an existing Task instance. This can be done using a transaction Bundle (also see the [[FHIR:Vprepub-1.0 Search result examples\|search results examples page]] for additional examples):
	<syntaxhighlight lang="xml" highlight="7-8,11,23-24,27-28,33-34,41-42" style="max-height:400px; overflow: auto;">		<syntaxhighlight lang="xml" highlight="7-8,11,23-24,27-28,33-34,41-42" style="max-height:400px; overflow: auto;">
	<Bundle xmlns="http://hl7.org/fhir">		<Bundle xmlns="http://hl7.org/fhir">

Pieter Edelman: Wijzigingen door Ashwin Djorai (Overleg) hersteld tot de laatste versie door Pieter Edelman

2022-05-03T07:59:38Z

Wijzigingen door Ashwin Djorai (Overleg) hersteld tot de laatste versie door Pieter Edelman

← Oudere versie		Versie van 3 mei 2022 07:59
Regel 322:		Regel 322:
	* HTTP 401 Unauthorized		* HTTP 401 Unauthorized
	* OperationOutcome with {{fhir\|.code}} set to {{term\|security}}		* OperationOutcome with {{fhir\|.code}} set to {{term\|security}}
	\| [[FHIR:V1.0 FHIR_Error_handling_examples#Not_authorized\|Example]]		\| [[FHIR:Vprepub-1.0 FHIR_Error_handling_examples#Not_authorized\|Example]]
	\|-		\|-
	\| Invalid authorization, scope of the access token is not sufficient for the request		\| Invalid authorization, scope of the access token is not sufficient for the request
Regel 328:		Regel 328:
	* HTTP 403 Forbidden		* HTTP 403 Forbidden
	* OperationOutcome with {{fhir\|.code}} set to {{term\|security}}		* OperationOutcome with {{fhir\|.code}} set to {{term\|security}}
	\| [[FHIR:V1.0 FHIR_Error_handling_examples#Invalid_authorization\|Example]]		\| [[FHIR:Vprepub-1.0 FHIR_Error_handling_examples#Invalid_authorization\|Example]]
	\|-		\|-
	\| Resource is not supported		\| Resource is not supported
Regel 334:		Regel 334:
	* HTTP 404 Not Found		* HTTP 404 Not Found
	* OperationOutcome with {{fhir\|.code}} set to {{term\|not-supported}}		* OperationOutcome with {{fhir\|.code}} set to {{term\|not-supported}}
	\| [[FHIR:V1.0 FHIR_Error_handling_examples#Resource_is_not_supported\|Example]]		\| [[FHIR:Vprepub-1.0 FHIR_Error_handling_examples#Resource_is_not_supported\|Example]]
	\|-		\|-
	\| rowspan=4 \|search		\| rowspan=4 \|search
Regel 355:		Regel 355:
	* OperationOutcome in Bundle as an entry marked with {{fhir\|Bundle.entry.search.mode}} of {{term\|outcome}}.		* OperationOutcome in Bundle as an entry marked with {{fhir\|Bundle.entry.search.mode}} of {{term\|outcome}}.
	* OperationOutcome with {{fhir\|.code}} set to {{term\|not-found}} and {{fhir\|.severity}} not set to {{term\|fatal}} or {{term\|error}}.		* OperationOutcome with {{fhir\|.code}} set to {{term\|not-found}} and {{fhir\|.severity}} not set to {{term\|fatal}} or {{term\|error}}.
	\| [[FHIR:V1.0 FHIR_Error_handling_examples#Unkown_or_unsupported_search_parameter_value\|Example]]		\| [[FHIR:Vprepub-1.0 FHIR_Error_handling_examples#Unkown_or_unsupported_search_parameter_value\|Example]]
	\|-		\|-
	\| read		\| read
Regel 362:		Regel 362:
	* HTTP 404 Not Found		* HTTP 404 Not Found
	* OperationOutcome with {{fhir\|.code}} set to {{term\|not-found}}		* OperationOutcome with {{fhir\|.code}} set to {{term\|not-found}}
	\| [[FHIR:V1.0 FHIR_Error_handling_examples#Request_on_an_unknown_id\|Example]]		\| [[FHIR:Vprepub-1.0 FHIR_Error_handling_examples#Request_on_an_unknown_id\|Example]]
	\|-		\|-
	\| update		\| update
Regel 369:		Regel 369:
	* HTTP 400 Bad Request		* HTTP 400 Bad Request
	* OperationOutcome with {{fhir\|.code}} set to {{term\|invalid}}		* OperationOutcome with {{fhir\|.code}} set to {{term\|invalid}}
	\| [[FHIR:V1.0 FHIR_Error_handling_examples#No_or_incorrect_Resource_id\|Example]]		\| [[FHIR:Vprepub-1.0 FHIR_Error_handling_examples#No_or_incorrect_Resource_id\|Example]]
	\|-		\|-
	\| create/update		\| create/update
Regel 376:		Regel 376:
	* HTTP 400 Bad Request or HTTP 422 Unprocessable Entity		* HTTP 400 Bad Request or HTTP 422 Unprocessable Entity
	* OperationOutcome with {{fhir\|.code}} set to {{term\|invalid}} or preferably a more specific child code.		* OperationOutcome with {{fhir\|.code}} set to {{term\|invalid}} or preferably a more specific child code.
	\| [[FHIR:V1.0 FHIR_Error_handling_examples#Resource_syntax_or_data_is_incorrect_or_invalid\|Example]]		\| [[FHIR:Vprepub-1.0 FHIR_Error_handling_examples#Resource_syntax_or_data_is_incorrect_or_invalid\|Example]]
	\|}		\|}
	<section end=OverarchingPrinciples />		<section end=OverarchingPrinciples />

Ashwin Djorai: MM-3096: OperationOutcome.code changes to OperationOutcome.issue.code conform the FHIR specs

2022-04-13T13:26:59Z

MM-3096: OperationOutcome.code changes to OperationOutcome.issue.code conform the FHIR specs

← Oudere versie		Versie van 13 apr 2022 13:26
Regel 322:		Regel 322:
	* HTTP 401 Unauthorized		* HTTP 401 Unauthorized
	* OperationOutcome with {{fhir\|.code}} set to {{term\|security}}		* OperationOutcome with {{fhir\|.code}} set to {{term\|security}}
	\| [[FHIR:~~Vprepub-1~~.0 FHIR_Error_handling_examples#Not_authorized\|Example]]		\| [[FHIR:V1.0 FHIR_Error_handling_examples#Not_authorized\|Example]]
	\|-		\|-
	\| Invalid authorization, scope of the access token is not sufficient for the request		\| Invalid authorization, scope of the access token is not sufficient for the request
Regel 328:		Regel 328:
	* HTTP 403 Forbidden		* HTTP 403 Forbidden
	* OperationOutcome with {{fhir\|.code}} set to {{term\|security}}		* OperationOutcome with {{fhir\|.code}} set to {{term\|security}}
	\| [[FHIR:~~Vprepub-1~~.0 FHIR_Error_handling_examples#Invalid_authorization\|Example]]		\| [[FHIR:V1.0 FHIR_Error_handling_examples#Invalid_authorization\|Example]]
	\|-		\|-
	\| Resource is not supported		\| Resource is not supported
Regel 334:		Regel 334:
	* HTTP 404 Not Found		* HTTP 404 Not Found
	* OperationOutcome with {{fhir\|.code}} set to {{term\|not-supported}}		* OperationOutcome with {{fhir\|.code}} set to {{term\|not-supported}}
	\| [[FHIR:~~Vprepub-1~~.0 FHIR_Error_handling_examples#Resource_is_not_supported\|Example]]		\| [[FHIR:V1.0 FHIR_Error_handling_examples#Resource_is_not_supported\|Example]]
	\|-		\|-
	\| rowspan=4 \|search		\| rowspan=4 \|search
Regel 355:		Regel 355:
	* OperationOutcome in Bundle as an entry marked with {{fhir\|Bundle.entry.search.mode}} of {{term\|outcome}}.		* OperationOutcome in Bundle as an entry marked with {{fhir\|Bundle.entry.search.mode}} of {{term\|outcome}}.
	* OperationOutcome with {{fhir\|.code}} set to {{term\|not-found}} and {{fhir\|.severity}} not set to {{term\|fatal}} or {{term\|error}}.		* OperationOutcome with {{fhir\|.code}} set to {{term\|not-found}} and {{fhir\|.severity}} not set to {{term\|fatal}} or {{term\|error}}.
	\| [[FHIR:~~Vprepub-1~~.0 FHIR_Error_handling_examples#Unkown_or_unsupported_search_parameter_value\|Example]]		\| [[FHIR:V1.0 FHIR_Error_handling_examples#Unkown_or_unsupported_search_parameter_value\|Example]]
	\|-		\|-
	\| read		\| read
Regel 362:		Regel 362:
	* HTTP 404 Not Found		* HTTP 404 Not Found
	* OperationOutcome with {{fhir\|.code}} set to {{term\|not-found}}		* OperationOutcome with {{fhir\|.code}} set to {{term\|not-found}}
	\| [[FHIR:~~Vprepub-1~~.0 FHIR_Error_handling_examples#Request_on_an_unknown_id\|Example]]		\| [[FHIR:V1.0 FHIR_Error_handling_examples#Request_on_an_unknown_id\|Example]]
	\|-		\|-
	\| update		\| update
Regel 369:		Regel 369:
	* HTTP 400 Bad Request		* HTTP 400 Bad Request
	* OperationOutcome with {{fhir\|.code}} set to {{term\|invalid}}		* OperationOutcome with {{fhir\|.code}} set to {{term\|invalid}}
	\| [[FHIR:~~Vprepub-1~~.0 FHIR_Error_handling_examples#No_or_incorrect_Resource_id\|Example]]		\| [[FHIR:V1.0 FHIR_Error_handling_examples#No_or_incorrect_Resource_id\|Example]]
	\|-		\|-
	\| create/update		\| create/update
Regel 376:		Regel 376:
	* HTTP 400 Bad Request or HTTP 422 Unprocessable Entity		* HTTP 400 Bad Request or HTTP 422 Unprocessable Entity
	* OperationOutcome with {{fhir\|.code}} set to {{term\|invalid}} or preferably a more specific child code.		* OperationOutcome with {{fhir\|.code}} set to {{term\|invalid}} or preferably a more specific child code.
	\| [[FHIR:~~Vprepub-1~~.0 FHIR_Error_handling_examples#Resource_syntax_or_data_is_incorrect_or_invalid\|Example]]		\| [[FHIR:V1.0 FHIR_Error_handling_examples#Resource_syntax_or_data_is_incorrect_or_invalid\|Example]]
	\|}		\|}
	<section end=OverarchingPrinciples />		<section end=OverarchingPrinciples />

Pieter Edelman: HOTFIX: Add STU3 to the tile

2021-12-09T13:45:29Z

HOTFIX: Add STU3 to the tile

← Oudere versie		Versie van 9 dec 2021 13:45
Regel 1:		Regel 1:
	__NOINDEX__		__NOINDEX__
	__NUMBEREDHEADINGS__		__NUMBEREDHEADINGS__
	{{DISPLAYTITLE:FHIR Implementation Guide}}		{{DISPLAYTITLE:FHIR STU3 Implementation Guide}}

	__TOC__		__TOC__

Pieter Edelman: HOTFIX: typo fix

2021-10-27T10:51:49Z

HOTFIX: typo fix

← Oudere versie		Versie van 27 okt 2021 10:51
Regel 404:		Regel 404:

	For even more background information:		For even more background information:
	* [https://confluence.hl7.org/display/FHIR/NPM+Package+Specification The HL7 base specification for FHIR ~~pacakges~~]		* [https://confluence.hl7.org/display/FHIR/NPM+Package+Specification The HL7 base specification for FHIR packages]
	* [https://blog.fire.ly/2017/11/28/versioning-and-canonical-urls/ What is the problem that packaging could address]		* [https://blog.fire.ly/2017/11/28/versioning-and-canonical-urls/ What is the problem that packaging could address]
	* [https://simplifier.net/organization/firely/news/55 Introducing the Simplifier FHIR Package Server] (includes what problem packaging addresses)		* [https://simplifier.net/organization/firely/news/55 Introducing the Simplifier FHIR Package Server] (includes what problem packaging addresses)

Eduard de Rijcke: MM-2436 Merge to vPrepub

2021-10-21T14:51:20Z

MM-2436 Merge to vPrepub

← Oudere versie		Versie van 21 okt 2021 14:51
Regel 57:		Regel 57:
	A key feature of FHIR is the ability of resources to reference each other. This is done using the [https://hl7.org/fhir/STU3/references.html#Reference {{datatype\|Reference}} datatype]. This datatype supports two modes of referencing:		A key feature of FHIR is the ability of resources to reference each other. This is done using the [https://hl7.org/fhir/STU3/references.html#Reference {{datatype\|Reference}} datatype]. This datatype supports two modes of referencing:
	; [https://hl7.org/fhir/STU3/references.html#literal Literal references], using the {{fhir\|.reference}} element: A relative or absolute REST endpoint containing {{fhir\|.id}} of the referenced resource. In a Bundle context, this may also be a reference to a {{fhir\|Bundle.resource.fullUrl}}.		; [https://hl7.org/fhir/STU3/references.html#literal Literal references], using the {{fhir\|.reference}} element: A relative or absolute REST endpoint containing {{fhir\|.id}} of the referenced resource. In a Bundle context, this may also be a reference to a {{fhir\|Bundle.resource.fullUrl}}.
	; [https://hl7.org/fhir/references.html#logical Logical references], using the {{fhir\|.identifier}} element: Meaning a match on the business identifier ({{fhir\|.identifier}}) for the referenced resource, without specifying where to find the referenced resource. Note: confusingly, although this reference type is called "logical reference", it does ''not'' act on the "logical identifier" ({{fhir\|.id}}) of resources.		; [https://hl7.org/fhir/STU3/references.html#logical Logical references], using the {{fhir\|.identifier}} element: Meaning a match on the business identifier ({{fhir\|.identifier}}) for the referenced resource, without specifying where to find the referenced resource. Note: confusingly, although this reference type is called "logical reference", it does ''not'' act on the "logical identifier" ({{fhir\|.id}}) of resources.

	The resource/profile will usually constrain which resources may be targeted from a given element. For example, {{fhir\|Patient.generalPractitioner}} may point only to an Organization or Practitioner resource, and the nl-core-patient profile further restricts this to the nl-core-organization and nl-core-practitioner profiles{{ref\|weakness-target-unavailable}}.		The resource/profile will usually constrain which resources may be targeted from a given element. For example, {{fhir\|Patient.generalPractitioner}} may point only to an Organization or Practitioner resource, and the nl-core-patient profile further restricts this to the nl-core-organization and nl-core-practitioner profiles{{ref\|weakness-target-unavailable}}.

Vincent Goris: MM-2392 improved section 'use of reference datatype' to include .reference when available.

2021-10-21T08:12:01Z

MM-2392 improved section 'use of reference datatype' to include .reference when available.

← Oudere versie		Versie van 21 okt 2021 08:12
Regel 69:		Regel 69:
	* A short description of the target resource SHALL be included using the {{fhir\|.display}} element.		* A short description of the target resource SHALL be included using the {{fhir\|.display}} element.

	''Note 1'': {{note\|weakness-target-unavailable}}In some circumstances, the constraints om the target are too strict for the use case and the appropriate resource can't be referenced (examples are {{fhir\|Encounter.participant}}, which cannot reference a PractitionerRole resource to provide context of the attending physician, and {{fhir\|Media.operator}}, which cannot target Patient resources and thus doesn't recognize patient-generated Media). In such cases, the proper reference type is added using an extension within the element that is used to refer the other resource. ~~Because some~~ receiving systems ~~may not be able to~~ handle ~~this~~ extension, the {{fhir\|.~~display~~}} ~~on both~~ the element ~~itself and~~ the extension ~~SHOULD be populated with~~ the ~~same value~~.		''Note 1'': {{note\|weakness-target-unavailable}}In some circumstances, the constraints om the target are too strict for the use case and the appropriate resource can't be referenced (examples are {{fhir\|Encounter.participant}}, which cannot reference a PractitionerRole resource to provide context of the attending physician, and {{fhir\|Media.operator}}, which cannot target Patient resources and thus doesn't recognize patient-generated Media). In such cases, the proper reference type is added using an extension within the element that is used to refer the other resource. To aid receiving systems that cannot handle the extension, the sending system SHOULD give as much information as possible in the main element. In the case of the {{Simplifier\|http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference\|nictiz.fhir.nl.stu3.zib2017\|title=PractitionerRole reference extension}}, this means that the sending system SHOULD populate the main element with the reference to the Practitioner resource. In most other cases, the sender SHOULD repeat the {{fhir\|.display}} used in the extension in the main element.

	''Note 2'': {{note\|weakness-unknown-type}}There is a known weakness in the Reference datatype for FHIR STU3 which is fixed in FHIR R4: if the reference might have more than one type of resource as target, a receiving system cannot know what type is meant when only an identifier is provided.		''Note 2'': {{note\|weakness-unknown-type}}There is a known weakness in the Reference datatype for FHIR STU3 which is fixed in FHIR R4: if the reference might have more than one type of resource as target, a receiving system cannot know what type is meant when only an identifier is provided.

Pieter Edelman: MM-2415: Make clear that status code 422 cannot be used in a transaction operation

2021-10-20T14:54:16Z

MM-2415: Make clear that status code 422 cannot be used in a transaction operation

← Oudere versie		Versie van 20 okt 2021 14:54
Regel 392:		Regel 392:
	* Sending secondary resources SHALL only be done when the information standard specifies that a {{fhir\|batch}} or {{fhir\|transaction}} operation is to be used.		* Sending secondary resources SHALL only be done when the information standard specifies that a {{fhir\|batch}} or {{fhir\|transaction}} operation is to be used.
	* If so, the client MAY send a bare-bones instance as the secondary resource containing just minimal information, but this SHOULD include the information necessary for the server to match its own copy. The information standard MAY specify which information is minimally needed for such a secondary resource and MAY also restrict the information that is sent in the secondary resource.		* If so, the client MAY send a bare-bones instance as the secondary resource containing just minimal information, but this SHOULD include the information necessary for the server to match its own copy. The information standard MAY specify which information is minimally needed for such a secondary resource and MAY also restrict the information that is sent in the secondary resource.
	* The client MUST include a {{fhir\|Bundle.entry.request}} for each of the resources in the Bundle, including the secondary resources that are only there for referencing purposes<ref>Although {{fhir\|Bundle.entry.request}} is not formally required in FHIR STU3, it is made clear in FHIR R4 that the expected behavior actually is to include it.</ref>. {{fhir\|.request}} SHOULD be a ~~{{term\|~~POST}} to the appropriate endpoint. As an alternative, ~~{{term\|~~PUT}} MAY be used, but is strongly discouraged; if the client has knowledge on the id of the resource on the server, an absolute URL is strongly preferred.		* The client MUST include a {{fhir\|Bundle.entry.request}} for each of the resources in the Bundle, including the secondary resources that are only there for referencing purposes<ref>Although {{fhir\|Bundle.entry.request}} is not formally required in FHIR STU3, it is made clear in FHIR R4 that the expected behavior actually is to include it.</ref>. {{fhir\|.request}} SHOULD be a <code>POST</code> to the appropriate endpoint. As an alternative, <code>PUT</code> MAY be used, but is strongly discouraged; if the client has knowledge on the id of the resource on the server, an absolute URL is strongly preferred.
	* If the server can unequivocally de-duplicate this secondary resource (for example, because the patient is already known from the security context or the healthcare provider is recognized by the UZI number), it MAY choose to ignore the differences of this resource or it MAY incorporate them (see the [https://www.hl7.org/fhir/stu3/http.html#transactional-integrity the section on transactional integity] in the FHIR specification). Please note that absence of information should not result in deletion of information on the server, as the client could send a bare-bones instance.		* If the server can unequivocally de-duplicate this secondary resource (for example, because the patient is already known from the security context or the healthcare provider is recognized by the UZI number), it MAY choose to ignore the differences of this resource or it MAY incorporate them (see the [https://www.hl7.org/fhir/stu3/http.html#transactional-integrity the section on transactional integity] in the FHIR specification). Please note that absence of information should not result in deletion of information on the server, as the client could send a bare-bones instance.
	** If the server chooses to ignore the differences, it:		** If a {{fhir\|transaction}} operation is used and the server chooses to ignore the differences, it SHOULD do so silently by responding with a 200 OK status code for the corresponding {{fhir\|Bundle.entry.response.status}} in the response Bundle.
	*** MAY do so silently by ~~using~~ a 200 OK status code for {{fhir\|Bundle.entry.response.status}} in the response Bundle~~, or it~~		** If a {{fhir\|batch}} operation is used and the server chooses to ignore the differences, it SHOULD do so either silently using the mechanism described above, or explicitly by responding with a 422 Unprocessable Entity status code {{fhir\|Bundle.entry.response.status}} to indicate that a business rule prevented the resource from being created (in combination with an OperationOutcome resource).
	*** MAY do so explicitly by ~~using~~ a 422 Unprocessable Entity status code {{fhir\|Bundle.entry.response.status}} to indicate that a business rule prevented the resource from being created~~. In this case, it is encouraged to include~~ an OperationOutcome resource ~~in the response detailing the reason the interaction was rejected~~.
	* The server SHALL rewrite the references in the primary resource to the resource it already has.		* The server SHALL rewrite the references in the primary resource to the resource it already has.

← Oudere versie		Versie van 21 okt 2021 14:51
Regel 57:		Regel 57:
	A key feature of FHIR is the ability of resources to reference each other. This is done using the [https://hl7.org/fhir/STU3/references.html#Reference {{datatype\|Reference}} datatype]. This datatype supports two modes of referencing:		A key feature of FHIR is the ability of resources to reference each other. This is done using the [https://hl7.org/fhir/STU3/references.html#Reference {{datatype\|Reference}} datatype]. This datatype supports two modes of referencing:
	; [https://hl7.org/fhir/STU3/references.html#literal Literal references], using the {{fhir\|.reference}} element: A relative or absolute REST endpoint containing {{fhir\|.id}} of the referenced resource. In a Bundle context, this may also be a reference to a {{fhir\|Bundle.resource.fullUrl}}.		; [https://hl7.org/fhir/STU3/references.html#literal Literal references], using the {{fhir\|.reference}} element: A relative or absolute REST endpoint containing {{fhir\|.id}} of the referenced resource. In a Bundle context, this may also be a reference to a {{fhir\|Bundle.resource.fullUrl}}.
	; [https://hl7.org/fhir/references.html#logical Logical references], using the {{fhir\|.identifier}} element: Meaning a match on the business identifier ({{fhir\|.identifier}}) for the referenced resource, without specifying where to find the referenced resource. Note: confusingly, although this reference type is called "logical reference", it does ''not'' act on the "logical identifier" ({{fhir\|.id}}) of resources.		; [https://hl7.org/fhir/STU3/references.html#logical Logical references], using the {{fhir\|.identifier}} element: Meaning a match on the business identifier ({{fhir\|.identifier}}) for the referenced resource, without specifying where to find the referenced resource. Note: confusingly, although this reference type is called "logical reference", it does ''not'' act on the "logical identifier" ({{fhir\|.id}}) of resources.

	The resource/profile will usually constrain which resources may be targeted from a given element. For example, {{fhir\|Patient.generalPractitioner}} may point only to an Organization or Practitioner resource, and the nl-core-patient profile further restricts this to the nl-core-organization and nl-core-practitioner profiles{{ref\|weakness-target-unavailable}}.		The resource/profile will usually constrain which resources may be targeted from a given element. For example, {{fhir\|Patient.generalPractitioner}} may point only to an Organization or Practitioner resource, and the nl-core-patient profile further restricts this to the nl-core-organization and nl-core-practitioner profiles{{ref\|weakness-target-unavailable}}.

← Oudere versie		Versie van 21 okt 2021 08:12
Regel 69:		Regel 69:
	* A short description of the target resource SHALL be included using the {{fhir\|.display}} element.		* A short description of the target resource SHALL be included using the {{fhir\|.display}} element.

	''Note 1'': {{note\|weakness-target-unavailable}}In some circumstances, the constraints om the target are too strict for the use case and the appropriate resource can't be referenced (examples are {{fhir\|Encounter.participant}}, which cannot reference a PractitionerRole resource to provide context of the attending physician, and {{fhir\|Media.operator}}, which cannot target Patient resources and thus doesn't recognize patient-generated Media). In such cases, the proper reference type is added using an extension within the element that is used to refer the other resource. ~~Because some~~ receiving systems ~~may not be able to~~ handle ~~this~~ extension, the {{fhir\|.~~display~~}} ~~on both~~ the element ~~itself and~~ the extension ~~SHOULD be populated with~~ the ~~same value~~.		''Note 1'': {{note\|weakness-target-unavailable}}In some circumstances, the constraints om the target are too strict for the use case and the appropriate resource can't be referenced (examples are {{fhir\|Encounter.participant}}, which cannot reference a PractitionerRole resource to provide context of the attending physician, and {{fhir\|Media.operator}}, which cannot target Patient resources and thus doesn't recognize patient-generated Media). In such cases, the proper reference type is added using an extension within the element that is used to refer the other resource. To aid receiving systems that cannot handle the extension, the sending system SHOULD give as much information as possible in the main element. In the case of the {{Simplifier\|http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference\|nictiz.fhir.nl.stu3.zib2017\|title=PractitionerRole reference extension}}, this means that the sending system SHOULD populate the main element with the reference to the Practitioner resource. In most other cases, the sender SHOULD repeat the {{fhir\|.display}} used in the extension in the main element.

	''Note 2'': {{note\|weakness-unknown-type}}There is a known weakness in the Reference datatype for FHIR STU3 which is fixed in FHIR R4: if the reference might have more than one type of resource as target, a receiving system cannot know what type is meant when only an identifier is provided.		''Note 2'': {{note\|weakness-unknown-type}}There is a known weakness in the Reference datatype for FHIR STU3 which is fixed in FHIR R4: if the reference might have more than one type of resource as target, a receiving system cannot know what type is meant when only an identifier is provided.