STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

??.??.3 Resource ResourceDescription - Detailed Descriptions

Detailed Descriptions for the elements in the ResourceDescription resource.

ResourceDescription
Definition

ResourceDescription represents the shared characteristics common to both abstract and resource version descriptions. ResourceDescription is an abstract type and, as such, cannot be directly created. Resource descriptions are Changeable, meaning that they have identity and can be created, updated and deleted.

Control0..*
TypeChangeable
ResourceDescription.about(about)
Definition

the (or a) definitive URI that represents the resource being described. Note that this is NOT the URI of the resource description in the CTS2 format, but of the resource itself. As an example, the about URI for the Wine ontology would be "http://www.w3.org/TR/2003/PR-owl-guide-20031209/wine#". The NCI Thesaurus has, amongst others, the about URI of http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#. HL7 uses ISO Object Identifiers (OIDs) to label resources so, from the HL7 perspective, the about URI of the NCI Thesaurus would be "urn:oid:2.16.840.1.113883.3.26.1.1"

Control1..1
TypeExternalURI
ResourceDescription.formalName(formalName)
Definition

the formal or officially assigned name of this resource, if any

Control0..1
TypeString
ResourceDescription.keyword(keyword)
Definition

additional identifiers that are used to index and locatethe resource

Control0..*
TypeString
ResourceDescription.resourceType(resourceType)
Definition

the class(es) that this resource instantiates

Control0..*
TypeURIAndEntityName
ResourceDescription.resourceSynopsis(resourceSynopsis)
Definition

a textual summary of the resource - what it is, what it is for, etc.

Control0..1
TypeEntryDescription
ResourceDescription.additionalDocumentation(additionalDocumentation)
Definition

a reference to a document thatprovide additional information about the resource

Control0..*
TypePersistentURI
ResourceDescription.sourceAndRole(sourceAndRole)
Definition

a reference to an individual, organization of bibliographic reference that participated in the creation, validation, review, dissemination of this resource and therole(s) they played

Control0..*
TypeSourceAndRoleReference
ResourceDescription.rights(rights)
Definition

copyright and IP information. Note that rights applies to the source resource, not the CTS2 rendering.

Control0..1
TypeOpaqueData
ResourceDescription.note(note)
Definition

an additional note or comment about the resource

Control0..*
TypeComment
ResourceDescription.property(property)
Definition

additional information about the resource that doesnot fit into any of the attributes described above

Control0..*
TypeProperty
ResourceDescription.alternateID(alternateID)
Definition

an alternative identifier that uniquely names this resource in other environments as contexts. As an example, if a resource had both an ISO Object Identifier and a DNS name, the DNS name might be assigned as the entryID of the resource by one service while the ISO OID would be recorded as an alternateURI using the "urn:oid" prefix. Note that alternateIds can be added or removed during resource updates.

Control0..*
TypeExternalURI
ResourceDescription.sourceStatements(sourceStatements)
Definition

a DirectoryURI that references the set of statements that were used to construct the containing resource. This attribute must (may?) be present if and only if the service supports the Statement profile

Control0..1
TypeStatementDirectoryURI