Resource Profile: MY Core Organization Profile

Defining URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
Version: 4.0.0
Name: MYCoreOrganizationProfile
Title: MY Core Organization Profile
Status: Active as of 2022-01-01
Definition:
Defines basic constraints and extensions on the Organization resource for use with other MY Core resources
Publisher: HL7 International - MY Realm Steering Committee
Copyright: Used by permission of HL7 International, all rights reserved Creative Commons License
Source Resource: XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/core/StructureDefinition/my-core-organization

This profile sets minimum expectations for the Organization resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the US Core-Organization profile:

Query by organization name or NPI

Mandatory and Must Support Data Elements

This profile sets minimum expectations for the Organization resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the US Core-Organization profile:

Query by organization name or NPI Mandatory and Must Support Data Elements The following data-elements must always be present (Mandatory definition]) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Organization must have:

  • A status of the organization
  • A name
  • Each Organization must support:

An identifier SHALL support National Provider Identifier (NPI) for organizations SHOULD support Clinical Laboratory Improvement Amendments (CLIA) for laboratories. A list of contact information An address Profile specific implementation guidance:

none

Example

Organization-acme-lab

Organization-with-EndPoint

Formal Views of Profile Content

Resource overview

Almost all overview tabs of any resource can be rendered in your Implementation Guide. StructureDefinitions have their own tree statement for this, other resources use the render statement.

StructureDefinition

You can define the StructureDefinition to be rendered by Canonical or point to a specific File in your project or on Simplifier.net. See the Intellisense page on how you can switch the autocomplete to support you in either.

For the File example the us-core-patient resource in the demo project is used. You can find the resource on https://simplifier.net/demo/us-core-patient-2. Notice that the path in the URL is exactly the same as the placeholder.

For the Canonical example we'll use the FHIR base patient.

Differential

Example based on file urlkey:

The resource cannot be rendered.

The exact same parameters can be used for rendering by canonical:

identifierΣ0..*Identifier
activeΣ ?!0..1boolean
nameΣ0..*HumanName
telecomΣ I0..*ContactPoint
genderΣ0..1codeBinding
birthDateΣ0..1date
deceasedBooleanboolean
deceasedDateTimedateTime
addressΣ0..*Address
maritalStatus0..1CodeableConceptBinding
multipleBirthBooleanboolean
multipleBirthIntegerinteger
photoI0..*Attachment
relationship0..*CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
gender0..1codeBinding
organizationI0..1Reference(Organization)
periodI0..1Period
language1..1CodeableConceptBinding
preferred0..1boolean
generalPractitionerI0..*Reference(Organization | Practitioner | PractitionerRole)
managingOrganizationΣ I0..1Reference(Organization)
otherΣ I1..1Reference(Patient | RelatedPerson)
typeΣ1..1codeBinding
Below we'll only continue to show the file example.

Hybrid

The resource cannot be rendered.

Snapshot (default)

The resource cannot be rendered.

Other resources

The render statement (without spaces between the brackets) enables you to render all other resources. See the below OperationDefinition (from https://simplifier.net/core-opdefs-stu3/ActivityDefinition-data-requirements) resource as an example.

Invocations

URL: [base]/ActivityDefinition/[id]/$data-requirements

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1Library

The result of the requirements gathering represented as a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the activity definition

The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the activity definition. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the activity definition and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)