FHIR Artifacts > Structure Definition: Organization Profile

Structure Definition: Organization Profile

Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Organization

Simplifier project page: Organization

Derived from: Organization (R4)

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
activeS Σ ?!0..1boolean
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
nameS Σ I1..1string
alias0..*string
systemS Σ I0..1codeBinding
valueS Σ1..1string
useS Σ ?!0..1codeBinding
rankS Σ0..1positiveInt
periodΣ I0..1Period
useS Σ ?!0..1codeBinding
typeS Σ0..1codeBinding
textS Σ0..1string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..1string
stateS Σ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
partOfΣ I0..1Reference(Organization)
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
useΣ ?!0..1codeBinding
textΣ0..1string
familyS Σ0..1string
givenS Σ0..*string
prefixΣ0..*string
suffixΣ0..*string
periodΣ I0..1Period
systemS Σ I0..1codeBinding
valueS Σ1..1string
useS Σ ?!0..1codeBinding
rankS Σ0..1positiveInt
periodΣ I0..1Period
useS Σ ?!0..1codeBinding
typeS Σ0..1codeBinding
textS Σ0..1string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..1string
stateS Σ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
endpointI0..*Reference(Endpoint)

Hybrid View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
activeS Σ ?!0..1boolean
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
nameS Σ I1..1string
alias0..*string
systemS Σ I0..1codeBinding
valueS Σ1..1string
useS Σ ?!0..1codeBinding
rankS Σ0..1positiveInt
periodΣ I0..1Period
useS Σ ?!0..1codeBinding
typeS Σ0..1codeBinding
textS Σ0..1string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..1string
stateS Σ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
partOfΣ I0..1Reference(Organization)
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
useΣ ?!0..1codeBinding
textΣ0..1string
familyS Σ0..1string
givenS Σ0..*string
prefixΣ0..*string
suffixΣ0..*string
periodΣ I0..1Period
systemS Σ I0..1codeBinding
valueS Σ1..1string
useS Σ ?!0..1codeBinding
rankS Σ0..1positiveInt
periodΣ I0..1Period
useS Σ ?!0..1codeBinding
typeS Σ0..1codeBinding
textS Σ0..1string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..1string
stateS Σ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
endpointI0..*Reference(Endpoint)

Snapshot View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
activeS Σ ?!0..1boolean
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
nameS Σ I1..1string
alias0..*string
systemS Σ I0..1codeBinding
valueS Σ1..1string
useS Σ ?!0..1codeBinding
rankS Σ0..1positiveInt
periodΣ I0..1Period
useS Σ ?!0..1codeBinding
typeS Σ0..1codeBinding
textS Σ0..1string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..1string
stateS Σ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
partOfΣ I0..1Reference(Organization)
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
useΣ ?!0..1codeBinding
textΣ0..1string
familyS Σ0..1string
givenS Σ0..*string
prefixΣ0..*string
suffixΣ0..*string
periodΣ I0..1Period
systemS Σ I0..1codeBinding
valueS Σ1..1string
useS Σ ?!0..1codeBinding
rankS Σ0..1positiveInt
periodΣ I0..1Period
useS Σ ?!0..1codeBinding
typeS Σ0..1codeBinding
textS Σ0..1string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..1string
stateS Σ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
endpointI0..*Reference(Endpoint)

Table View

Organization..
Organization.meta1..
Organization.meta.profile1..
Organization.identifier..
Organization.identifier.system..
Organization.identifier.value..
Organization.active..
Organization.type..
Organization.type.coding..
Organization.type.coding.system..
Organization.type.coding.code..
Organization.type.coding.display..
Organization.name1..
Organization.telecom..
Organization.telecom.system..
Organization.telecom.value1..
Organization.telecom.use..
Organization.telecom.rank..
Organization.address..
Organization.address.use..
Organization.address.type..
Organization.address.text..
Organization.address.line..
Organization.address.city..
Organization.address.state..
Organization.address.postalCode..
Organization.address.country..
Organization.contact..
Organization.contact.purpose..
Organization.contact.purpose.coding..
Organization.contact.purpose.coding.system..
Organization.contact.purpose.coding.code..
Organization.contact.purpose.coding.display..
Organization.contact.name..
Organization.contact.name.family..
Organization.contact.name.given..
Organization.contact.telecom..
Organization.contact.telecom.system..
Organization.contact.telecom.value1..
Organization.contact.telecom.use..
Organization.contact.telecom.rank..
Organization.contact.address..
Organization.contact.address.use..
Organization.contact.address.type..
Organization.contact.address.text..
Organization.contact.address.line..
Organization.contact.address.city..
Organization.contact.address.state..
Organization.contact.address.postalCode..
Organization.contact.address.country..
Organization.endpoint..


JSON View

{
    "resourceType": "StructureDefinition",
    "id": "ca-on-eReferral-profile-Organization",
    "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Organization",
    "version": "1.0.0",
    "name": "EReferralOrganization",
    "title": "Organization",
    "status": "draft",
    "description": "Organization profile describes the details of the organization where the referral originated from.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Organization",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Organization",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Organization.meta",
                "path": "Organization.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.meta.profile",
                "path": "Organization.meta.profile",
                "comment": "#### **_` FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Organization|1.0.0 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.  The list of profile URLs is a set.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.identifier",
                "path": "Organization.identifier",
                "mustSupport": true
            },
            {
                "id": "Organization.identifier.system",
                "path": "Organization.identifier.system",
                "mustSupport": true
            },
            {
                "id": "Organization.identifier.value",
                "path": "Organization.identifier.value",
                "mustSupport": true
            },
            {
                "id": "Organization.active",
                "path": "Organization.active",
                "mustSupport": true
            },
            {
                "id": "Organization.type",
                "path": "Organization.type",
                "mustSupport": true
            },
            {
                "id": "Organization.type.coding",
                "path": "Organization.type.coding",
                "mustSupport": true
            },
            {
                "id": "Organization.type.coding.system",
                "path": "Organization.type.coding.system",
                "mustSupport": true
            },
            {
                "id": "Organization.type.coding.code",
                "path": "Organization.type.coding.code",
                "mustSupport": true
            },
            {
                "id": "Organization.type.coding.display",
                "path": "Organization.type.coding.display",
                "mustSupport": true
            },
            {
                "id": "Organization.name",
                "path": "Organization.name",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.telecom",
                "path": "Organization.telecom",
                "mustSupport": true
            },
            {
                "id": "Organization.telecom.system",
                "path": "Organization.telecom.system",
                "mustSupport": true
            },
            {
                "id": "Organization.telecom.value",
                "path": "Organization.telecom.value",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.telecom.use",
                "path": "Organization.telecom.use",
                "mustSupport": true
            },
            {
                "id": "Organization.telecom.rank",
                "path": "Organization.telecom.rank",
                "mustSupport": true
            },
            {
                "id": "Organization.address",
                "path": "Organization.address",
                "mustSupport": true
            },
            {
                "id": "Organization.address.use",
                "path": "Organization.address.use",
                "mustSupport": true
            },
            {
                "id": "Organization.address.type",
                "path": "Organization.address.type",
                "mustSupport": true
            },
            {
                "id": "Organization.address.text",
                "path": "Organization.address.text",
                "mustSupport": true
            },
            {
                "id": "Organization.address.line",
                "path": "Organization.address.line",
                "mustSupport": true
            },
            {
                "id": "Organization.address.city",
                "path": "Organization.address.city",
                "mustSupport": true
            },
            {
                "id": "Organization.address.state",
                "path": "Organization.address.state",
                "mustSupport": true
            },
            {
                "id": "Organization.address.postalCode",
                "path": "Organization.address.postalCode",
                "mustSupport": true
            },
            {
                "id": "Organization.address.country",
                "path": "Organization.address.country",
                "mustSupport": true
            },
            {
                "id": "Organization.contact",
                "path": "Organization.contact",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.purpose",
                "path": "Organization.contact.purpose",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.purpose.coding",
                "path": "Organization.contact.purpose.coding",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.purpose.coding.system",
                "path": "Organization.contact.purpose.coding.system",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.purpose.coding.code",
                "path": "Organization.contact.purpose.coding.code",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.purpose.coding.display",
                "path": "Organization.contact.purpose.coding.display",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.name",
                "path": "Organization.contact.name",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.name.family",
                "path": "Organization.contact.name.family",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.name.given",
                "path": "Organization.contact.name.given",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.telecom",
                "path": "Organization.contact.telecom",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.telecom.system",
                "path": "Organization.contact.telecom.system",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.telecom.value",
                "path": "Organization.contact.telecom.value",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.contact.telecom.use",
                "path": "Organization.contact.telecom.use",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.telecom.rank",
                "path": "Organization.contact.telecom.rank",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address",
                "path": "Organization.contact.address",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address.use",
                "path": "Organization.contact.address.use",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address.type",
                "path": "Organization.contact.address.type",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address.text",
                "path": "Organization.contact.address.text",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address.line",
                "path": "Organization.contact.address.line",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address.city",
                "path": "Organization.contact.address.city",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address.state",
                "path": "Organization.contact.address.state",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address.postalCode",
                "path": "Organization.contact.address.postalCode",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address.country",
                "path": "Organization.contact.address.country",
                "mustSupport": true
            },
            {
                "id": "Organization.endpoint",
                "path": "Organization.endpoint",
                "mustSupport": false
            }
        ]
    }
}

Usage

The Organization Resource is used to share contact and other information for various organizations or it can be used merely as a support for other resources that need to reference organizations.

Notes

.id

  • used to uniquely identify the resource
  • if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in Bundle.entry.fullUrl)

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Organization|1.0.0

.type

  • identifies the kind of organization
  • expected to be = "prov" (Healthcare Provider) in nearly all cases.

.telecom

  • list of entries used for the inquiry phone, email, fax for the HEAD OFFICE of the Organization
  • in most cases this element does NOT need to be displayed to users sending referrals as it may get confused with the HealthcareService.telecom info (which is of higher relevance for referrals and not necessarily related the information in this element.)

.address

  • list of entries used for the inquiry phone, email, fax for the HEAD OFFICE of the Organization
  • in most cases this element does NOT need to be displayed to users sending referrals as it may get confused with the HealthcareService.location address information (which is of higher relevance for referrals and not necessarily related the information in this element.)