Use Case - Search for an Endpoint
To Search for an Endpoint you can search for it directly, or by referencing it's Organization.
| Endpoint | C | DomainResource | Element idEndpointShort description The technical details of an endpoint that can be used for electronic services DefinitionThe technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.idShort description Logical id of this artifact DefinitionThe 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. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idEndpoint.metaShort description Metadata about the resource DefinitionThe 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.
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idEndpoint.implicitRulesShort description A set of rules under which this content was created DefinitionA 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.
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idEndpoint.languageShort description Language of the resource content DefinitionThe 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 human language.
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idEndpoint.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idEndpoint.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEndpoint.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEndpoint.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idEndpoint.identifierShort description Identifies this endpoint across multiple systems DefinitionIdentifier for the organization that is used to identify the endpoint across multiple disparate systems. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | Element idEndpoint.statusShort description active | suspended | error | off | entered-in-error | test Definitionactive | suspended | error | off | test. This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. The status of the endpoint.
| ||
| connectionType | Σ | 1..1 | CodingBinding | Element idEndpoint.connectionTypeShort description Protocol/Profile/Standard to be used with this endpoint connection DefinitionA coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. EndpointConnectionType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 0..1 | string | Element idEndpoint.nameShort description A name that this endpoint can be identified by DefinitionA friendly name that this endpoint can be referred to with. Note that FHIR strings SHALL NOT exceed 1MB in size
| ||
| managingOrganization | Σ C | 0..1 | Reference(Organization) | Element idEndpoint.managingOrganizationShort description Organization that manages this endpoint (might not be the organization that exposes the endpoint) DefinitionThe organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | C | 0..* | ContactPoint | Element idEndpoint.contactShort description Contact details for source (e.g. troubleshooting) DefinitionContact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | Element idEndpoint.periodShort description Interval the endpoint is expected to be operational DefinitionThe interval during which the endpoint is expected to be operational. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| payloadType | Σ | 1..* | CodeableConcept | Element idEndpoint.payloadTypeShort description The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) DefinitionThe payload type describes the acceptable content that can be communicated on the endpoint. The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| payloadMimeType | Σ | 0..* | codeBinding | Element idEndpoint.payloadMimeTypeShort description Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) DefinitionThe mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType). Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured. The mime type of an attachment. Any valid mime type is allowed.
| ||
| address | Σ | 1..1 | url | Element idEndpoint.addressShort description The technical base address for connecting to this endpoint DefinitionThe uri that describes the actual end-point to connect to. For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs) This address will be to the service base, without any parameters, or sub-services or resources tacked on. E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs" and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".
| ||
| header | 0..* | string | Element idEndpoint.headerShort description Usage depends on the channel type DefinitionAdditional headers / information to send as part of the notification. Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.
|
Search by Endpoint
Endpoint.identifier
Definition: Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
Invocations
[base]/Endpoint?identifier=[system]|[value]
Search by Endpoint Organization
Endpoint.managingOrganization
Definition: The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).
Invocations
[base]/Endpoint?organization=Organization/[id]
| UKCoreOrganization (Organization) | C | Organization | There are no (further) constraints on this element Element idOrganizationShort description A grouping of people or organizations with a common purpose DefinitionA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.idShort description Logical id of this artifact DefinitionThe 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. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.metaShort description Metadata about the resource DefinitionThe 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.
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.implicitRulesShort description A set of rules under which this content was created DefinitionA 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.
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.languageShort description Language of the resource content DefinitionThe 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 human language.
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | Element idOrganization.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. Unordered, Open, by url(Value) Constraints
| ||
| mainLocation | C | 0..1 | Extension(Reference(Location)) | Element idOrganization.extension:mainLocationShort description The main location of the organisation. Alternate namesextensions, user content DefinitionThe main location of the organisation. 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. Extension(Reference(Location)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| organizationPeriod | C | 0..1 | Extension(Period) | Element idOrganization.extension:organizationPeriodShort description The date range that this organization SHOULD be considered available. Alternate namesextensions, user content DefinitionThe date range that this organization SHOULD be considered available. 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. http://hl7.org/fhir/StructureDefinition/organization-period ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.extension:organizationPeriod.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.extension:organizationPeriod.extensionShort description Extension DefinitionAn Extension Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.extension:organizationPeriod.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/StructureDefinition/organization-periodMappings
| |||
| value[x] | 1..1 | Element idOrganization.extension:organizationPeriod.value[x]Short description The date range that this organization SHOULD be considered available. DefinitionThe date range that this organization SHOULD be considered available.
| ||||
| valuePeriod | Period | There are no (further) constraints on this element Data type | ||||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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. 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.
| ||
| identifier | S Σ C | 0..* | Identifier | Element idOrganization.identifierShort description Identifies this organization across multiple systems. DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: org-1 Constraints
| ||
| odsOrganisationCode | Σ C | 0..1 | Identifier | Element idOrganization.identifier:odsOrganisationCodeShort description Organisation Data Service code DefinitionIdentifier code supplier by the Organisation Data Service. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. The cardinality or value of this element may be affected by these constraints: org-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idOrganization.identifier:odsOrganisationCode.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/ods-organization-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.valueShort description The value that is unique DefinitionThe 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. 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.
General 123456Mappings
| ||
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
| assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.assignerShort description Organization that issued id (may be just text) DefinitionOrganization 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.
| ||
| odsSiteCode | Σ C | 0..1 | Identifier | Element idOrganization.identifier:odsSiteCodeShort description ODS Site code to identify the organisation at site level DefinitionODS Site code to identify the organisation at site level. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. The cardinality or value of this element may be affected by these constraints: org-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idOrganization.identifier:odsSiteCode.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/ods-site-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.valueShort description The value that is unique DefinitionThe 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. 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.
General 123456Mappings
| ||
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
| assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.assignerShort description Organization that issued id (may be just text) DefinitionOrganization 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.
| ||
| active | S Σ ?! | 0..1 | boolean | Element idOrganization.activeShort description Identifies this organization across multiple systems. DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
| ||
| type | Σ | 0..* | CodeableConceptBinding | Element idOrganization.typeShort description Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts UKCoreOrganizationType (extensible) Constraints
| ||
| name | S Σ C | 0..1 | string | Element idOrganization.nameShort description A name associated with the organization. DefinitionA name associated with the organization. Need to use the name as the label of the organization. If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. The cardinality or value of this element may be affected by these constraints: org-1 Constraints
| ||
| alias | 0..* | string | There are no (further) constraints on this element Element idOrganization.aliasShort description A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
| |||
| telecom | S C | 0..* | ContactPoint | Element idOrganization.telecomShort description Contact details for the organization. DefinitionA contact detail for the organization. Human contact for the organization. The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. The cardinality or value of this element may be affected by these constraints: org-3 Constraints
| ||
| address | S C | 0..* | Address | Element idOrganization.addressShort description An address for the organization. DefinitionAn address for the organization. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. The cardinality or value of this element may be affected by these constraints: org-2 Constraints
| ||
| partOf | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.partOfShort description The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization.
| ||
| contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contactShort description Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.contact.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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. 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.
| ||
| purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purposeShort description The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. The purpose for which you would contact a contact party. ContactEntityType (extensible) Constraints
| |||
| name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.nameShort description A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name.
| |||
| telecom | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecomShort description Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email.
| |||
| address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.addressShort description Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements.
| |||
| endpoint | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpointShort description Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
|
Search by Organization Endpoint
Organization.endpoint
Definition: Technical endpoints providing access to services operated for the organization.
Invocations [base]/Organization?endpoint=Endpoint/[id]
Invocations [base]/Organization?identifier=[system]|[value]