HL7 AU Conventions: profile metadata

The following conventions apply to HL7 AU Core StructureDefinition resources for standard profiles (of resources and datatypes).

Resource elements

element	include	convention
filename		<id>'.xml' e.g. au-core-patient.xml
StructureDefinition.id	yes	'au-core-'<resource type in lower case> e.g. au-core-organization or au-core-allergyintollerance
StructureDefinition.language	no
StructureDefinition.url	yes	'http://hl7.org.au/fhir/core/StructureDefinition/'<id> e.g. http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient
StructureDefinition.identifier	no
StructureDefinition.version	no	Semantic versioning strategy is in place. Versions are currently handled by ig.xml
StructureDefinition.name	yes	The format for the name is <AUCore><resource-type> or <AUCore><use case>. For example without the use case, 'AUCore' followed by resource type in upper camel case with the original spelling, e.g. AUCoreOrganization or AUCoreAllergyIntolerance, and with use case 'AUCore'followed by the use case description does not have to match the id e.g. AUCore Body Temperature or AU Core Head Circumference
StructureDefinition.title	yes	The name with spaces e.g. AU Core Organization
StructureDefinition.status	yes	For a new StructureDefinition: 'draft'
StructureDefinition.experimental	no
StructureDefinition.date	no	Will be updated via the publishing process
StructureDefinition.publisher	no	This is currently handled by ig.xml
StructureDefinition.contact	no	This is currently handled by ig.xml
StructureDefinition.description	yes	This profile sets minimum expectations for <a/an> <resource type> resource to record, search, and fetch information.... It is based on the <base> profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that *SHALL* be present in the <resource type> when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context. It provides the floor for standards development for specific uses cases in an Australian context.'
StructureDefinition.useContext	no
StructureDefinition.jurisdiction	no	This is currently handled by ig.xml
StructureDefinition.purpose	no
StructureDefinition.copyright	yes	1) Always present but set in ig.xml: 'Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights ' 2) If the profile has a code that is a fixed value from SNOMED CT then the following content shall follow the standard statement: 'This resource includes SNOMED Clinical Terms™ (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. “SNOMED” and “SNOMED CT” are registered trademarks of the IHTSDO. The rights to use and implement or implementation of SNOMED CT content are limited to the extent it is necessary to allow for the end use of this material. No further rights are granted in respect of the International Release and no further use of any SNOMED CT content by any other party is permitted.' 3) If the profile has a code that is a fixed value from LOINC then the following content shall follow the standard statement (refer to https://loinc.org/kb/license/ point 10.1): 'This material contains content from LOINC (http://loinc.org). LOINC is copyright © 1995-2022, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.'
StructureDefinition.kind	yes	'resource'
StructureDefinition.abstract	yes	'false'
StructureDefinition.type	yes	<resourcename> OR <datatypename>