Structure Definition: Organization Profile


Status: Pending change to .category element see issue #79


Canonical URL: https://signalbhn.org/fhir/StructureDefinition/SignalUSCoreOrganizationProfile

Simplifier project page: Signal Organization

Derived from: US Core Organization STU6 (R4)

Module: Organization Services Module


Formal profile content

url1..1System.StringFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
url1..1System.StringFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
photoI0..*Extension(Attachment)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
NPIS Σ I0..*IdentifierPattern
CLIAΣ I0..*IdentifierPattern
NAICΣ I0..*IdentifierPattern
activeS Σ ?!1..1boolean
npiTaxonomyΣ1..*CodeableConceptBinding
nameS Σ I1..1string
alias0..*string
systemS Σ I0..1codeBinding
valueS Σ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineS Σ0..4string
cityS Σ0..1string
districtΣ0..1string
stateS Σ0..1stringBinding
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
partOfΣ I0..1Reference(Organization)
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
endpointI0..*Reference(Endpoint)
url1..1System.StringFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
url1..1System.StringFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
photoI0..*Extension(Attachment)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
NPIS Σ I0..*IdentifierPattern
CLIAΣ I0..*IdentifierPattern
NAICΣ I0..*IdentifierPattern
activeS Σ ?!1..1boolean
npiTaxonomyΣ1..*CodeableConceptBinding
nameS Σ I1..1string
alias0..*string
systemS Σ I0..1codeBinding
valueS Σ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineS Σ0..4string
cityS Σ0..1string
districtΣ0..1string
stateS Σ0..1stringBinding
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
partOfΣ I0..1Reference(Organization)
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
endpointI0..*Reference(Endpoint)
{
    "resourceType": "StructureDefinition",
    "url": "https://signalbhn.org/fhir/StructureDefinition/SignalUSCoreOrganizationProfile",
    "name": "SignalUSCoreOrganizationProfile",
    "status": "draft",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Organization",
    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Organization.extension:qualification",
                "path": "Organization.extension",
                "sliceName": "qualification",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://signalbhn.org/fhir/StructureDefinition/qualification"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Organization.extension:qualification.extension:code",
                "path": "Organization.extension.extension",
                "sliceName": "code"
            },
            {
                "id": "Organization.extension:qualification.extension:code.value[x]",
                "path": "Organization.extension.extension.value[x]",
                "binding": {
                    "strength": "required",
                    "valueSet": "https://signalbhn.org/fhir/ValueSet/signal-organization-license"
                }
            },
            {
                "id": "Organization.extension:photo",
                "path": "Organization.extension",
                "sliceName": "photo",
                "short": "Image or logo for the organization",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://signalbhn.org/fhir/StructureDefinition/SignalOrgPhotoAttachment"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Organization.type",
                "path": "Organization.type",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "coding.system"
                        }
                    ],
                    "description": "Differentiate on code system used to capture information.",
                    "rules": "open"
                },
                "binding": {
                    "strength": "required",
                    "valueSet": "https://signalbhn.org/fhir/us/core/ValueSet/signal-organization-type"
                }
            },
            {
                "id": "Organization.type:npiTaxonomy",
                "path": "Organization.type",
                "sliceName": "npiTaxonomy",
                "short": "NPI Provider Taxonomy Code",
                "definition": "A taxonomy code is a unique 10-character code that designates your classification and specialization. You will use this code when applying for a National Provider Identifier, commonly referred to as an NPI.",
                "comment": "For NPI Taxonomy, use this ValueSet: Valueset-provider-taxonomy - FHIR v5.0.0 (hl7.org). More information:\n\nhttps://taxonomy.nucc.org/\nThe Health Care Provider Taxonomy code set is an external, nonmedical data code set designed for use in an electronic environment, specifically within the ASC X12N Health Care transactions. This includes the transactions mandated under HIPAA.\nThe taxonomy code is a unique alphanumeric code, ten characters in length. The code set is structured into three distinct \"Levels\" including Provider Grouping, Classification, and Area of Specialization.\nFind Your Taxonomy Code | CMS (https://www.cms.gov/medicare/provider-enrollment-and-certification/find-your-taxonomy-code)\n\nNote: You may select more than one code or code description when applying for an NPI, but you must indicate one of them as the primary code.",
                "min": 1,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/provider-taxonomy"
                }
            }
        ]
    }
}

Profile usage

The Organization resource is used to collect information on healthcare service providers, provider locations, or service organizations that may be used as support for other resources that need to reference organizations. Hierarchies (levels via Organization.partOf), affiliations (via the OrganizationAffliation resource), and services (via the HealthcareServices resource) are established to provide context into relationships and capabilities of each organization.

Profile element notes

.identifier

  • Business identifier(s) specific to this resource
  • Identifier corresponding to slices below SHALL utilize those slices
  • Identifiers corresponding to clinicians/practitioners SHOULD be included on Practitioner resource
  • MAY contain identifiers from external systems
  • Slices:
    • identifier:NPI - National Provider Identifier (NPI)
      • Required for Signal
      • SHOULD match to the NPI Taxonomy registered with CMS which SHOULD be included on .type:npiTaxonomy
    • identifier:CLIA - Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
    • identifier:NAIC - NAIC Code

.identifier.system

  • The namespace for the identifier value (i.e., the “source identifier issuer system”), where the value must be unique within the system.

.identifier.value

  • SHOULD contain a unique value for the identifier within its system
  • Master Record identifiers (generated by a Master Record Holder, MRH) SHALL use UUIDs or some other globally unique naming convention.

.identifier.assigner

  • MAY contain a reference to the organization issuing the identifier
  • MAY contain only a string of text

.name

  • SHOULD contain the name of the organization presented to providers and users, e.g., "Denver Medical"

.type

  • Cstom code system that identifies the kind of organization (e.g. service organization, provider agency, provider location)
  • Does not explicitly denote hierarchy. See the .partOf element and the OrganizationAffiliation resource for more information. Slices:
    • .type:npiTaxonomy - representing NPI Provider Taxonomy Code (from CMS)

.partOf

  • SHALL reference an existing Organization resource when used
  • The organization that wholly or partly owns the current organization; e.g. Provider locations are part of an Provider/State Agency
  • Most common example is the specific provider location for a provider agency; e.g. 'Denver West' provider location would contain .partOf='Denver Medical'
  • This relationship will be used for determining user access to services associated with Patients at the provider agency

.extension:qualification

  • Represents the same purpose as the Organization.qualification element now included in Organization (R5)
  • Signal custom code system and valueset that identifies services (licenses) a provider is qualified to offer.
  • Qualification address SHALL match the .address field

.extension:photo

  • Used to store Organization logo for use in the user interface (UI)
  • Logo will be placed in storage and URI provided for the file, so use the “.url” not “.data” field, to prevent search API filesizes from being too large.
  • File size and type constraints to be applied by implementation partners
  • Restricted to “safe” data types
    • Images: jpeg, jpg, png, gif, ico

.addresss

  • SHOULD contain information about the physical location of this organization.
  • SHALL match the location on licenses (defined in extension:qualification).

Examples