Generated Narrative: StructureDefinition MODS-DSCRTransferParametersOutput-1 Name Flags Card. Type Description & Constraints Parameters 0..* Parameters Operation Request or Response #xD; Slices for parameter 8..* BackboneElement Operation Parameter Slice: Unordered, Open by value:name #xD; parameter:operationOutcome 1..1 BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: operationOutcome #xD; resource 1..1 OperationOutcome If parameter is a whole resource #xD; parameter:subject 1..1 BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: subject #xD; value[x] 1..1 Reference(MODS Patient) If parameter is a data type #xD; reference 0..0 Literal reference, Relative, internal or absolute URL #xD; identifier 1..1 Identifier Logical reference, when literal reference is not known #xD; system 1..1 uri The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number #xD; value 1..1 string The value that is unique #xD; display 1..1 string Text alternative for the resource #xD; parameter:fulfiller 1..1 BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: fulfiller #xD; value[x] 1..1 Reference(MODS Organization) If parameter is a data type #xD; reference 0..0 Literal reference, Relative, internal or absolute URL #xD; identifier 1..1 Identifier Logical reference, when literal reference is not known #xD; system 1..1 uri The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code #xD; value 1..1 string The value that is unique #xD; display 1..1 string Text alternative for the resource #xD; parameter:fulfilledBy 0..1 BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: fulfilledBy #xD; value[x] 0..1 Reference(MODS Practitioner) If parameter is a data type #xD; reference 0..0 Literal reference, Relative, internal or absolute URL #xD; identifier 1..1 Identifier Logical reference, when literal reference is not known #xD; value 1..1 string The value that is unique #xD; display 1..1 string Text alternative for the resource #xD; parameter:requestor 1..1 BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: requestor #xD; value[x] 1..1 Reference(MODS Organization) If parameter is a data type #xD; reference 0..0 Literal reference, Relative, internal or absolute URL #xD; identifier 1..1 Identifier Logical reference, when literal reference is not known #xD; system 1..1 uri The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code #xD; value 1..1 string The value that is unique #xD; display 1..1 string Text alternative for the resource #xD; parameter:requestedBy 1..1 BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: requestedBy #xD; value[x] 1..1 Reference(MODS Practitioner) If parameter is a data type #xD; reference 0..0 Literal reference, Relative, internal or absolute URL #xD; identifier 1..1 Identifier Logical reference, when literal reference is not known #xD; value 1..1 string The value that is unique #xD; display 1..1 string Text alternative for the resource #xD; parameter:targetCompletion 0..1 BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: targetCompletion #xD; value[x] 1..1 date If parameter is a data type #xD; parameter:status 1..1 BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: status #xD; value[x] 1..1 code If parameter is a data type Binding: MODS DSCR Transfer Status (required) #xD; parameter:note 0..* BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: note #xD; Slices for part 2..* Named part of a multi-part parameter Slice: Unordered, Open by value:name #xD; part:date 1..1 BackboneElement Named part of a multi-part parameter #xD; name 1..1 string Name from the definition Fixed Value: date #xD; value[x] 1..1 dateTime If parameter is a data type #xD; part:text 1..1 BackboneElement Named part of a multi-part parameter #xD; name 1..1 string Name from the definition Fixed Value: text #xD; value[x] 1..1 string If parameter is a data type Max Length:250 #xD; parameter:statusLastUpdated 1..1 BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: statusLastUpdated #xD; value[x] 1..1 dateTime If parameter is a data type #xD; parameter:requestorTrackingId 1..1 BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: requestorTrackingId #xD; value[x] 1..1 string If parameter is a data type #xD; parameter:fulfillerTrackingId 0..1 BackboneElement Operation Parameter #xD; name 1..1 string Name from the definition Fixed Value: fulfillerTrackingId #xD; value[x] 0..1 string If parameter is a data type #xD; Documentation for this format
Synanetics Ltd on behalf of DHSC/Social Care Interoperability Platform
Output parameters for $transfer. Returns OperationOutcome first and echoes logical-only references (identifier + display).
United Kingdom of Great Britain and Northern Ireland
This resource is a non-persisted resource used to pass information into and back from an [operation](http://hl7.org/fhir/R4/operations.html). It has no other use, and there is no RESTful endpoint associated with it.
The parameters that may be used are defined by the OperationDefinition resource.
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
A parameter passed to or received from the operation.
A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The name of the parameter (reference to the operation definition).
When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
Only one level of nested parameters is allowed.
Extensions are always sliced by (at least) url
Literal reference, Relative, internal or absolute URL
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Type the reference refers to (e.g. "Patient")
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Aa resource (or, for logical models, the URI of the logical model).
Logical reference, when literal reference is not known
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Identifier.system is always case sensitive.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.