Directory of Service (Interoperability Standard)

Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.

Use Case - Search for an Endpoint

To Search for an Endpoint you can search for it directly, or by referencing it's Organization.

Endpoint	I		DomainResource	Element id Endpoint Short description The technical details of an endpoint that can be used for electronic services Definition The 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. Data type DomainResource Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act rim: n/a
id	Σ	0..1	string	There are no (further) constraints on this element Element id Endpoint.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Endpoint.meta Short description Metadata about the resource Definition 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Endpoint.implicitRules Short description A set of rules under which this content was created Definition 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. Comments 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Endpoint.language Short description Language of the resource content Definition The base language in which the resource is written. Comments 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Endpoint.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A 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. Comments 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. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Endpoint.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These 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. Comments 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. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May 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). Requirements 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
identifier	Σ	0..*	Identifier	Element id Endpoint.identifier Short description Identifies this endpoint across multiple systems Definition Identifier for the organization that is used to identify the endpoint across multiple disparate systems. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier
status	Σ ?!	1..1	codeBinding	Element id Endpoint.status Short description active \| suspended \| error \| off \| entered-in-error \| test Definition active \| suspended \| error \| off \| test. Comments This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. Data type code Binding The status of the endpoint. EndpointStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status rim: n/a
connectionType	Σ	1..1	CodingBinding	Element id Endpoint.connectionType Short description Protocol/Profile/Standard to be used with this endpoint connection Definition A 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). Comments For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. Data type Coding Binding EndpointConnectionType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding w5: FiveWs.class
name	Σ	0..1	string	Element id Endpoint.name Short description A name that this endpoint can be identified by Definition A friendly name that this endpoint can be referred to with. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: n/a
managingOrganization	Σ I	0..1	Reference(Organization)	Element id Endpoint.managingOrganization Short description Organization that manages this endpoint (might not be the organization that exposes the endpoint) 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). Comments 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. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
contact	I	0..*	ContactPoint	Element id Endpoint.contact Short description Contact details for source (e.g. troubleshooting) Definition Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. Data type ContactPoint Constraints cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN rim: TEL servd: ContactPoint
period	Σ I	0..1	Period	Element id Endpoint.period Short description Interval the endpoint is expected to be operational Definition The interval during which the endpoint is expected to be operational. Comments 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. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5: FiveWs.done[x]
payloadType	Σ	1..*	CodeableConcept	Element id Endpoint.payloadType Short description The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Definition The payload type describes the acceptable content that can be communicated on the endpoint. Comments 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. Data type CodeableConcept Binding EndpointPayloadType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
payloadMimeType	Σ	0..*	codeBinding	Element id Endpoint.payloadMimeType Short description Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Definition The 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). Comments Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured. Data type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
address	Σ	1..1	url	Element id Endpoint.address Short description The technical base address for connecting to this endpoint Definition The uri that describes the actual end-point to connect to. Comments 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/...". Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
header		0..*	string	Element id Endpoint.header Short description Usage depends on the channel type Definition Additional headers / information to send as part of the notification. Comments Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`

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]

<SearchParameter xmlns="http://hl7.org/fhir">
    <id value="Endpoint-identifier" />
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use" />
    </extension>
    <url value="http://hl7.org/fhir/SearchParameter/Endpoint-identifier" />
    <version value="4.0.1" />
    <name value="identifier" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="Health Level Seven International (Patient Administration)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
    </contact>
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://www.hl7.org/Special/committees/pafm/index.cfm" />
        </telecom>
    </contact>
    <description value="Identifies this endpoint across multiple systems" />
    <code value="identifier" />
    <base value="Endpoint" />
    <type value="token" />
    <expression value="Endpoint.identifier" />
    <xpath value="f:Endpoint/f:identifier" />
    <xpathUsage value="normal" />
</SearchParameter>

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]

<SearchParameter xmlns="http://hl7.org/fhir">
    <id value="Endpoint-organization" />
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use" />
    </extension>
    <url value="http://hl7.org/fhir/SearchParameter/Endpoint-organization" />
    <version value="4.0.1" />
    <name value="organization" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="Health Level Seven International (Patient Administration)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
    </contact>
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://www.hl7.org/Special/committees/pafm/index.cfm" />
        </telecom>
    </contact>
    <description value="The organization that is managing the endpoint" />
    <code value="organization" />
    <base value="Endpoint" />
    <type value="reference" />
    <expression value="Endpoint.managingOrganization" />
    <xpath value="f:Endpoint/f:managingOrganization" />
    <xpathUsage value="normal" />
    <target value="Organization" />
</SearchParameter>

UKCoreOrganization (Organization)	I		Organization	There are no (further) constraints on this element Element id Organization Short description A grouping of people or organizations with a common purpose Definition A 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. Data type Organization Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() org-1: The organization SHALL at least have a name or an identifier, and possibly more than one `(identifier.count() + name.count()) > 0` Mappings rim: Entity. Role, or Act v2: (also see master files messages) rim: Organization(classCode=ORG, determinerCode=INST) servd: Organization
id	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Organization.meta Short description Metadata about the resource Definition 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Organization.implicitRules Short description A set of rules under which this content was created Definition 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. Comments 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Organization.language Short description Language of the resource content Definition The base language in which the resource is written. Comments 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Organization.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A 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. Comments 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. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Organization.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These 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. Comments 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. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	Element id Organization.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
mainLocation	I	0..1	Extension(Reference(Location))	Element id Organization.extension:mainLocation Short description The main location of the organisation. Alternate names extensions, user content Definition The main location of the organisation. Comments 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. Data type Extension(Reference(Location)) Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A rim: n/a
organizationPeriod	I	0..1	Extension(Period)	Element id Organization.extension:organizationPeriod Short description The date range that this organization SHOULD be considered available. Alternate names extensions, user content Definition The date range that this organization SHOULD be considered available. Comments 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. Data type Extension(Period) Extension URL http://hl7.org/fhir/StructureDefinition/organization-period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Organization.extension:organizationPeriod.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..0	Extension	There are no (further) constraints on this element Element id Organization.extension:organizationPeriod.extension Short description Extension Definition An Extension Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
url		1..1	uriFixed Value	There are no (further) constraints on this element Element id Organization.extension:organizationPeriod.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments 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. Data type uri Fixed value http://hl7.org/fhir/StructureDefinition/organization-period Mappings rim: N/A
value[x]		1..1		Element id Organization.extension:organizationPeriod.value[x] Short description The date range that this organization SHOULD be considered available. Definition The date range that this organization SHOULD be considered available. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
valuePeriod			Period	There are no (further) constraints on this element Data type Period
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Organization.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May 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). Requirements 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. Comments 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
identifier	S Σ I	0..*	Identifier	Element id Organization.identifier Short description Identifies this organization across multiple systems. Definition Identifier for the organization that is used to identify the organization across multiple disparate systems. Requirements Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Data type Identifier Sliced: Unordered, Open, by system(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
odsOrganisationCode	Σ I	0..1	Identifier	Element id Organization.identifier:odsOrganisationCode Short description Organisation Data Service code Definition Identifier code supplier by the Organisation Data Service. Requirements Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
id		0..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments 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. Data type CodeableConcept Binding 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 ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
system	Σ	1..1	uriFixed Value	Element id Organization.identifier:odsOrganisationCode.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements 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. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://fhir.nhs.uk/Id/ods-organization-code Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments 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. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
odsSiteCode	Σ I	0..1	Identifier	Element id Organization.identifier:odsSiteCode Short description ODS Site code to identify the organisation at site level Definition ODS Site code to identify the organisation at site level. Requirements Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
id		0..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments 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. Data type CodeableConcept Binding 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 ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
system	Σ	1..1	uriFixed Value	Element id Organization.identifier:odsSiteCode.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements 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. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://fhir.nhs.uk/Id/ods-site-code Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments 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. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
active	S Σ ?!	0..1	boolean	Element id Organization.active Short description Identifies this organization across multiple systems. Definition Whether the organization's record is still in active use. Requirements Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. Comments 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. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status v2: No equivalent in HL7 v2 rim: .status servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
type	Σ	0..*	CodeableConceptBinding	Element id Organization.type Short description Kind of organization Definition The kind(s) of organization that this is. Requirements Need to be able to track the kind of organization that this is - different organization types have different uses. Comments 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. Data type CodeableConcept Binding A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts UKCoreOrganizationType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class v2: No equivalent in v2 rim: .code servd: n/a
name	S Σ I	0..1	string	Element id Organization.name Short description A name associated with the organization. Definition A name associated with the organization. Requirements Need to use the name as the label of the organization. Comments 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XON.1 rim: .name servd: .PreferredName/Name
alias		0..*	string	There are no (further) constraints on this element Element id Organization.alias Short description A list of alternate names that the organization is known as, or was known as in the past Definition A list of alternate names that the organization is known as, or was known as in the past. Requirements 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. Comments 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .name
telecom	S I	0..*	ContactPoint	Element id Organization.telecom Short description Contact details for the organization. Definition A contact detail for the organization. Requirements Human contact for the organization. Comments 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. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` org-3: The telecom of an organization can never be of use 'home' `where(use = 'home').empty()` Mappings v2: ORC-22? rim: .telecom servd: ./ContactPoints
address	S I	0..*	Address	Element id Organization.address Short description An address for the organization. Definition An address for the organization. Requirements May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Comments Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` org-2: An address of an organization can never be of use 'home' `where(use = 'home').empty()` Mappings v2: ORC-23? rim: .address servd: ./PrimaryAddress and ./OtherAddresses
partOf	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.partOf Short description The organization of which this organization forms a part Definition The organization of which this organization forms a part. Requirements Need to be able to track the hierarchy of organizations within an organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: No equivalent in HL7 v2 rim: .playedBy[classCode=Part].scoper servd: n/a
contact		0..*	BackboneElement	There are no (further) constraints on this element Element id Organization.contact Short description Contact for the organization for a certain purpose Definition Contact for the organization for a certain purpose. Requirements Need to keep track of assigned contact points within bigger organization. Comments 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .contactParty
id		0..1	string	There are no (further) constraints on this element Element id Organization.contact.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.contact.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Organization.contact.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition 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). Requirements 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. Comments 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
purpose		0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Organization.contact.purpose Short description The type of contact Definition Indicates a purpose for which the contact can be reached. Requirements Need to distinguish between multiple contact persons. Data type CodeableConcept Binding The purpose for which you would contact a contact party. ContactEntityType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./type
name		0..1	HumanName	There are no (further) constraints on this element Element id Organization.contact.name Short description A name associated with the contact Definition A name associated with the contact. Requirements Need to be able to track the person by name. Data type HumanName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-5, PID-9 rim: ./name
telecom		0..*	ContactPoint	There are no (further) constraints on this element Element id Organization.contact.telecom Short description Contact details (telephone, email, etc.) for a contact Definition A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. Requirements People have (primary) ways to contact them in some way such as phone, email. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-13, PID-14 rim: ./telecom
address		0..1	Address	There are no (further) constraints on this element Element id Organization.contact.address Short description Visiting or postal addresses for the contact Definition Visiting or postal addresses for the contact. Requirements May need to keep track of a contact party's address for contacting, billing or reporting requirements. Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-11 rim: ./addr
endpoint		0..*	Reference(Endpoint)	There are no (further) constraints on this element Element id Organization.endpoint Short description Technical endpoints providing access to services operated for the organization Definition Technical endpoints providing access to services operated for the organization. Requirements 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. Data type Reference(Endpoint) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

Search by Organization Endpoint

Organization.endpoint

Definition: Technical endpoints providing access to services operated for the organization.

Invocations [base]/Organization?endpoint=Endpoint/[id]

<SearchParameter xmlns="http://hl7.org/fhir">
    <id value="Organization-endpoint" />
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use" />
    </extension>
    <url value="http://hl7.org/fhir/SearchParameter/Organization-endpoint" />
    <version value="4.0.1" />
    <name value="endpoint" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="Health Level Seven International (Patient Administration)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
    </contact>
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://www.hl7.org/Special/committees/pafm/index.cfm" />
        </telecom>
    </contact>
    <description value="Technical endpoints providing access to services operated for the organization" />
    <code value="endpoint" />
    <base value="Organization" />
    <type value="reference" />
    <expression value="Organization.endpoint" />
    <xpath value="f:Organization/f:endpoint" />
    <xpathUsage value="normal" />
    <target value="Endpoint" />
</SearchParameter>

Invocations [base]/Organization?identifier=[system]|[value]

<SearchParameter xmlns="http://hl7.org/fhir">
    <id value="Organization-identifier" />
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use" />
    </extension>
    <url value="http://hl7.org/fhir/SearchParameter/Organization-identifier" />
    <version value="4.0.1" />
    <name value="identifier" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="Health Level Seven International (Patient Administration)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
    </contact>
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://www.hl7.org/Special/committees/pafm/index.cfm" />
        </telecom>
    </contact>
    <description value="Any identifier for the organization (not the accreditation issuer&#39;s identifier)" />
    <code value="identifier" />
    <base value="Organization" />
    <type value="token" />
    <expression value="Organization.identifier" />
    <xpath value="f:Organization/f:identifier" />
    <xpathUsage value="normal" />
</SearchParameter>